 |
ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
|
ITK
5.0.0
Insight Segmentation and Registration Toolkit
|
#include <itkArray.h>
Inheritance diagram for itk::Array< TValue >: Collaboration diagram for itk::Array< TValue >:Array class with size defined at construction time.
This class derives from the vnl_vector<> class. Its size is assigned at construction time (run time) and can not be changed afterwards except by using assignment to another Array.
The class is templated over the type of the elements.
Template parameters for class Array:
Definition at line 46 of file itkArray.h.
Public Types | |
| using | Self = Array |
| using | SizeValueType = typename vnl_vector< TValue >::size_type |
| using | ValueType = TValue |
| using | VnlVectorType = vnl_vector< TValue > |
Public Member Functions | |
| Array () | |
| Array (const Array &) | |
| Array (SizeValueType dimension) | |
| Array (ValueType *data, SizeValueType sz, bool LetArrayManageMemory=false) | |
| Array (const ValueType *datain, SizeValueType sz) | |
| void | Fill (TValue const &v) |
| const TValue & | GetElement (SizeValueType i) const |
| SizeValueType | GetSize () const |
| const Self & | operator= (const Self &rhs) |
| const Self & | operator= (const VnlVectorType &rhs) |
| void | SetData (TValue *data, SizeValueType sz, bool LetArrayManageMemory=false) |
| void | SetDataSameSize (TValue *data, bool LetArrayManageMemory=false) |
| void | SetElement (SizeValueType i, const TValue &value) |
| void | SetSize (SizeValueType sz) |
| void | Swap (Array &other) |
| ~Array () | |
| template<typename TArrayValue > | |
| Array (const Array< TArrayValue > &r) | |
| SizeValueType | Size () const |
| unsigned int | GetNumberOfElements () const |
Private Attributes | |
| bool | m_LetArrayManageMemory |
| using itk::Array< TValue >::Self = Array |
Definition at line 52 of file itkArray.h.
| using itk::Array< TValue >::SizeValueType = typename vnl_vector< TValue>::size_type |
Definition at line 54 of file itkArray.h.
| using itk::Array< TValue >::ValueType = TValue |
The element type stored at each location in the Array.
Definition at line 51 of file itkArray.h.
| using itk::Array< TValue >::VnlVectorType = vnl_vector< TValue > |
Definition at line 53 of file itkArray.h.
| itk::Array< TValue >::Array | ( | ) |
Default constructor. It is created with an empty array it has to be allocated later by assignment
| itk::Array< TValue >::Array | ( | const Array< TValue > & | ) |
Copy constructor. Uses VNL copy construtor with correct setting for memory management.
|
explicit |
Constructor with size. Size can only be changed by assignment
| itk::Array< TValue >::Array | ( | ValueType * | data, |
| SizeValueType | sz, | ||
| bool | LetArrayManageMemory = false |
||
| ) |
Constructor that initializes array with contents from a user supplied buffer. The pointer to the buffer and the length is specified. By default, the array does not manage the memory of the buffer. It merely points to that location and it is the user's responsibility to delete it. If "LetArrayManageMemory" is true, then this class will free the memory when this object is destroyed.
| itk::Array< TValue >::Array | ( | const ValueType * | datain, |
| SizeValueType | sz | ||
| ) |
Constructor that initializes array with contents from a user supplied const buffer. The pointer to the buffer and the length is specified. By default, the array does a deep copy of the const pointer data, so the array class also manages memory.
|
inline |
Constructor to initialize an array from another of any data type
Definition at line 97 of file itkArray.h.
| itk::Array< TValue >::~Array | ( | ) |
This destructor is not virtual for performance reasons. However, this means that subclasses cannot allocate memory.
|
inline |
Set the all the elements of the array to the specified value
Definition at line 109 of file itkArray.h.
Referenced by itk::MatchCardinalityImageToImageMetric< TFixedImage, TMovingImage >::GetDerivative(), itk::NumericTraits< Array< T > >::max(), itk::NumericTraits< Array< T > >::min(), itk::NumericTraits< Array< T > >::NonpositiveMin(), itk::NumericTraits< Array< T > >::OneValue(), itk::NumericTraits< Array< T > >::SetLength(), and itk::NumericTraits< Array< T > >::ZeroValue().
|
inline |
Get one element
Definition at line 127 of file itkArray.h.
|
inline |
Return the number of elements in the Array
Definition at line 122 of file itkArray.h.
|
inline |
Definition at line 137 of file itkArray.h.
Referenced by itk::Array< AccumulateType >::Array(), itk::NumericTraits< Array< T > >::GetLength(), itk::OptimizerParametersHelper< TValue >::MoveDataPointer(), and itk::MetaArrayWriter::SetMultiChannelInput().
| const Self& itk::Array< TValue >::operator= | ( | const Self & | rhs | ) |
Copy opertor
| const Self& itk::Array< TValue >::operator= | ( | const VnlVectorType & | rhs | ) |
| void itk::Array< TValue >::SetData | ( | TValue * | data, |
| SizeValueType | sz, | ||
| bool | LetArrayManageMemory = false |
||
| ) |
Similar to the previous method. In the above method, the size must be separately set prior to using user-supplied data. This introduces an unnecessary allocation step to be performed. This method avoids it and should be used to import data wherever possible to avoid this. Set the pointer from which the data is imported. If "LetArrayManageMemory" is false, then the application retains the responsibility of freeing the memory for this data. If "LetArrayManageMemory" is true, then this class will free the memory when this object is destroyed.
Referenced by itk::MetaArrayReader::GetOutput(), and itk::OptimizerParametersHelper< TValue >::MoveDataPointer().
| void itk::Array< TValue >::SetDataSameSize | ( | TValue * | data, |
| bool | LetArrayManageMemory = false |
||
| ) |
Set the pointer from which the data is imported. If "LetArrayManageMemory" is false, then the application retains the responsibility of freeing the memory for this data. If "LetArrayManageMemory" is true, then this class will free the memory when this object is destroyed. NOTE: This signature requires that internal array is being replaced by data array of exactly the same size
|
inline |
Set one element
Definition at line 131 of file itkArray.h.
| void itk::Array< TValue >::SetSize | ( | SizeValueType | sz | ) |
Destructively set the size to that given. Will lose data.
Referenced by itk::TranslationTransform< TParametersValueType, NDimensions >::GetFixedParameters(), itk::MetaArrayReader::GetMultiChannelOutput(), itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >::LabelStatistics::LabelStatistics(), and itk::NumericTraits< Array< T > >::SetLength().
|
inline |
Return the number of elements in the Array
Definition at line 120 of file itkArray.h.
Referenced by itk::Statistics::MeasurementVectorTraits::Assert(), itk::NumericTraits< Array< T > >::max(), itk::NumericTraits< Array< T > >::min(), itk::NumericTraits< Array< T > >::NonpositiveMin(), itk::NumericTraits< Array< T > >::OneValue(), itk::AutomaticTopologyMeshSource< TOutputMesh >::IdentifierArrayHashFunction::operator()(), itk::AutomaticTopologyMeshSource< TOutputMesh >::IdentifierArrayEqualsFunction::operator()(), itk::MetaArrayWriter::SetInput(), itk::DisplacementFieldTransform< TParametersValueType, NDimensions >::SetParameters(), itk::MeshIOBase::SetPixelType(), itk::ImageRegistrationMethodv4< TFixedImage, TMovingImage, TOutputTransform, TVirtualImage, TPointSet >::SetShrinkFactorsPerLevel(), SimpleMultiResolutionImageRegistrationUI2< TRegistration >::StartNewLevel(), and itk::NumericTraits< Array< T > >::ZeroValue().
|
inline |
Definition at line 175 of file itkArray.h.
Referenced by itk::swap().
|
private |
Definition at line 184 of file itkArray.h.
Referenced by itk::Array< AccumulateType >::Swap().
1.8.5
