Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType > Class Template Reference

Presents a color image as being composed of the Luminance of its pixels. More...

#include <itkRGBToLuminanceImageAdaptor.h>

+ Inheritance diagram for itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >:
+ Collaboration diagram for itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >:

Public Types

typedef
DefaultPixelAccessorFunctor
< Self
AccessorFunctorType
 
typedef
Accessor::RGBToLuminancePixelAccessor
< TImage::PixelType,
TOutputPixelType > 
AccessorType
 
typedef SmartPointer< const SelfConstPointer
 
typedef WeakPointer< const SelfConstWeakPointer
 
typedef Superclass::DirectionType DirectionType
 
typedef Superclass::IndexType IndexType
 
typedef IndexType::IndexValueType IndexValueType
 
typedef TImage InternalImageType
 
typedef InternalPixelTypeInternalPixelPointerType
 
typedef
Accessor::RGBToLuminancePixelAccessor
< TImage::PixelType,
TOutputPixelType >
::InternalType 
InternalPixelType
 
typedef PixelType IOPixelType
 
typedef Superclass::OffsetType OffsetType
 
typedef OffsetType::OffsetValueType OffsetValueType
 
typedef TImage::PixelContainer PixelContainer
 
typedef
TImage::PixelContainerConstPointer 
PixelContainerConstPointer
 
typedef
TImage::PixelContainerPointer 
PixelContainerPointer
 
typedef
Accessor::RGBToLuminancePixelAccessor
< TImage::PixelType,
TOutputPixelType >
::ExternalType 
PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::PointType PointType
 
typedef double PointValueType
 
typedef Superclass::RegionType RegionType
 
typedef RGBToLuminanceImageAdaptor Self
 
typedef Superclass::SizeType SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef Superclass::SpacingType SpacingType
 
typedef double SpacingValueType
 
typedef ImageAdaptor< TImage,
Accessor::RGBToLuminancePixelAccessor
< typename TImage::PixelType,
TOutputPixelType > > 
Superclass
 

Public Member Functions

unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
void Allocate ()
 
IndexType ComputeIndex (OffsetValueType offset) const
 
OffsetValueType ComputeOffset (const IndexType &ind) const
 
virtual void CopyInformation (const DataObject *data)
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
void DataHasBeenGenerated ()
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
virtual void Delete ()
 
void DisconnectPipeline ()
 
virtual const RegionTypeGetBufferedRegion () const
 
InternalPixelTypeGetBufferPointer ()
 
const InternalPixelTypeGetBufferPointer () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDataReleased () const
 
bool GetDebug () const
 
virtual const DirectionTypeGetDirection ()
 
virtual const DirectionTypeGetDirection () const
 
virtual const RegionTypeGetLargestPossibleRegion () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) const
 
virtual unsigned long GetMTime () const
 
virtual const char * GetNameOfClass () const
 
virtual unsigned int GetNumberOfComponentsPerPixel () const
 
const OffsetValueTypeGetOffsetTable () const
 
virtual const PointTypeGetOrigin ()
 
virtual const PointTypeGetOrigin () const
 
virtual const unsigned long & GetPipelineMTime ()
 
PixelType GetPixel (const IndexType &index) const
 
AccessorTypeGetPixelAccessor (void)
 
const AccessorTypeGetPixelAccessor (void) const
 
PixelContainerPointer GetPixelContainer ()
 
const PixelContainerGetPixelContainer () const
 
virtual int GetReferenceCount () const
 
virtual const bool & GetReleaseDataFlag ()
 
virtual const RegionTypeGetRequestedRegion () const
 
SmartPointerForwardReference
< ProcessObject
GetSource () const
 
unsigned int GetSourceOutputIndex () const
 
virtual const SpacingTypeGetSpacing ()
 
virtual const SpacingTypeGetSpacing () const
 
virtual unsigned long GetUpdateMTime () const
 
virtual void Graft (const DataObject *data)
 
bool HasObserver (const EventObject &event) const
 
virtual void Initialize ()
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
PixelType operator[] (const IndexType &index) const
 
virtual void PrepareForNewData ()
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void PropagateRequestedRegion () throw (InvalidRequestedRegionError)
 
virtual void Register () const
 
void ReleaseData ()
 
virtual void ReleaseDataFlagOff ()
 
virtual void ReleaseDataFlagOn ()
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
virtual bool RequestedRegionIsOutsideOfTheBufferedRegion ()
 
virtual void ResetPipeline ()
 
virtual void SetBufferedRegion (const RegionType &region)
 
virtual void SetBufferedRegion (const RegionType &region)
 
void SetDebug (bool debugFlag) const
 
virtual void SetDirection (const DirectionType direction)
 
virtual void SetDirection (const DirectionType direction)
 
virtual void SetImage (TImage *)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
virtual void SetLargestPossibleRegion (const RegionType &region)
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetNumberOfComponentsPerPixel (unsigned int)
 
virtual void SetOrigin (PointType _arg)
 
virtual void SetOrigin (const double origin[VImageDimension])
 
virtual void SetOrigin (const float origin[VImageDimension])
 
virtual void SetOrigin (const PointType values)
 
virtual void SetOrigin (const double *values)
 
virtual void SetOrigin (const float *values)
 
void SetPipelineMTime (unsigned long time)
 
void SetPixel (const IndexType &index, const PixelType &value)
 
void SetPixelAccessor (const AccessorType &accessor)
 
void SetPixelContainer (PixelContainer *container)
 
virtual void SetReferenceCount (int)
 
void SetReleaseDataFlag (bool flag)
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual void SetRequestedRegion (DataObject *data)
 
virtual void SetRequestedRegion (const RegionType &region)
 
virtual void SetRequestedRegionToLargestPossibleRegion ()
 
virtual void SetSpacing (const SpacingType &values)
 
virtual void SetSpacing (const double *values)
 
virtual void SetSpacing (const float *values)
 
virtual void SetSpacing (const SpacingType &spacing)
 
virtual void SetSpacing (const double spacing[VImageDimension])
 
virtual void SetSpacing (const float spacing[VImageDimension])
 
bool ShouldIReleaseData () const
 
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &index, Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &point) const
 
void TransformContinuousIndexToPhysicalPoint (const ContinuousIndex< TCoordRep, VImageDimension > &index, Point< TCoordRep, VImageDimension > &point) const
 
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &point) const
 
void TransformIndexToPhysicalPoint (const IndexType &index, Point< TCoordRep, VImageDimension > &point) const
 
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &inputGradient, FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &outputGradient) const
 
void TransformLocalVectorToPhysicalVector (const FixedArray< TCoordRep, VImageDimension > &inputGradient, FixedArray< TCoordRep, VImageDimension > &outputGradient) const
 
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &point, ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &index) const
 Get the continuous index from a physical point. More...
 
bool TransformPhysicalPointToContinuousIndex (const Point< TCoordRep, VImageDimension > &point, ContinuousIndex< TCoordRep, VImageDimension > &index) const
 Get the continuous index from a physical point. More...
 
bool TransformPhysicalPointToIndex (const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &point, IndexType &index) const
 
bool TransformPhysicalPointToIndex (const Point< TCoordRep, VImageDimension > &point, IndexType &index) const
 
virtual void UnRegister () const
 
virtual void Update ()
 
virtual void UpdateOutputData ()
 
virtual void UpdateOutputInformation ()
 
virtual bool VerifyRequestedRegion ()
 

Static Public Member Functions

static void BreakOnError ()
 
static bool GetGlobalReleaseDataFlag ()
 
static bool GetGlobalWarningDisplay ()
 
static unsigned int GetImageDimension ()
 
static void GlobalReleaseDataFlagOff ()
 
static void GlobalReleaseDataFlagOn ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalReleaseDataFlag (bool val)
 
static void SetGlobalWarningDisplay (bool flag)
 

Static Public Attributes

static const unsigned int ImageDimension
 

Protected Types

typedef int InternalReferenceCountType
 

Protected Member Functions

 RGBToLuminanceImageAdaptor ()
 
virtual ~RGBToLuminanceImageAdaptor ()
 
virtual void ComputeIndexToPhysicalPointMatrices ()
 
void ComputeOffsetTable ()
 
virtual void InitializeBufferedRegion (void)
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual void PropagateResetPipeline ()
 

Protected Attributes

DirectionType m_Direction
 
DirectionType m_IndexToPhysicalPoint
 
PointType m_Origin
 
DirectionType m_PhysicalPointToIndex
 
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 
SpacingType m_Spacing
 

Private Member Functions

 RGBToLuminanceImageAdaptor (const Self &)
 
void operator= (const Self &)
 

Detailed Description

template<class TImage, class TOutputPixelType>
class itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >

Presents a color image as being composed of the Luminance of its pixels.

Additional casting is performed according to the input and output image types following C++ default casting rules. The input color pixel type must provide a GetLuminance() method.

Definition at line 69 of file itkRGBToLuminanceImageAdaptor.h.

Member Typedef Documentation

typedef DefaultPixelAccessorFunctor< Self > itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::AccessorFunctorType
inherited

typedef of the functor that chooses the appropriate accessor Image or VectorImage.

Definition at line 89 of file itkImageAdaptor.h.

typedef Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::AccessorType
inherited

Accessor type that convert data between internal and external representations.

Definition at line 85 of file itkImageAdaptor.h.

template<class TImage , class TOutputPixelType >
typedef SmartPointer<const Self> itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::ConstPointer

Definition at line 82 of file itkRGBToLuminanceImageAdaptor.h.

typedef WeakPointer<const Self> itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::ConstWeakPointer
inherited

Definition at line 62 of file itkImageAdaptor.h.

typedef Superclass::DirectionType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::DirectionType
inherited

Direction typedef support. The Direction is a matix of direction cosines that specify the direction between samples.

Definition at line 118 of file itkImageAdaptor.h.

typedef Superclass::IndexType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::IndexType
inherited

Index typedef support. An index is used to access pixel values.

Definition at line 92 of file itkImageAdaptor.h.

typedef IndexType::IndexValueType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::IndexValueType
inherited

Definition at line 93 of file itkImageAdaptor.h.

typedef TImage itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::InternalImageType
inherited

Typedef of unadapted image

Definition at line 65 of file itkImageAdaptor.h.

typedef InternalPixelType* itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::InternalPixelPointerType
inherited

Convenient typedef.

Definition at line 228 of file itkImageAdaptor.h.

typedef Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > ::InternalType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::InternalPixelType
inherited

Pixel typedef support. Used to declare pixel type in filters or other operations.

Definition at line 79 of file itkImageAdaptor.h.

typedef int itk::LightObject::InternalReferenceCountType
protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

typedef PixelType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::IOPixelType
inherited

Definition at line 81 of file itkImageAdaptor.h.

typedef Superclass::OffsetType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::OffsetType
inherited

Offset typedef support.

Definition at line 100 of file itkImageAdaptor.h.

typedef OffsetType::OffsetValueType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::OffsetValueType
inherited

Definition at line 101 of file itkImageAdaptor.h.

typedef TImage::PixelContainer itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::PixelContainer
inherited

PixelContainer typedef support. Used to construct a container for the pixel data.

Definition at line 200 of file itkImageAdaptor.h.

typedef TImage::PixelContainerConstPointer itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::PixelContainerConstPointer
inherited

Definition at line 202 of file itkImageAdaptor.h.

typedef TImage::PixelContainerPointer itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::PixelContainerPointer
inherited

Definition at line 201 of file itkImageAdaptor.h.

typedef Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > ::ExternalType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::PixelType
inherited

Pixel typedef support. Used to declare pixel type in filters or other operations.

Definition at line 71 of file itkImageAdaptor.h.

template<class TImage , class TOutputPixelType >
typedef SmartPointer<Self> itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::Pointer

Definition at line 81 of file itkRGBToLuminanceImageAdaptor.h.

typedef Superclass::PointType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::PointType
inherited

Origin typedef support. The origin is the geometric coordinates of the index (0,0).

Definition at line 113 of file itkImageAdaptor.h.

typedef double itk::ImageBase< VImageDimension >::PointValueType
inherited

Origin typedef support. The origin is the geometric coordinates of the index (0,0).

Definition at line 133 of file itkImageBase.h.

typedef Superclass::RegionType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::RegionType
inherited

Region typedef support. A region is used to specify a subset of an image.

Definition at line 105 of file itkImageAdaptor.h.

template<class TImage , class TOutputPixelType >
typedef RGBToLuminanceImageAdaptor itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::Self

Standard class typedefs.

Definition at line 77 of file itkRGBToLuminanceImageAdaptor.h.

typedef Superclass::SizeType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SizeType
inherited

Size typedef support. A size is used to define region bounds.

Definition at line 96 of file itkImageAdaptor.h.

typedef SizeType::SizeValueType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SizeValueType
inherited

Definition at line 97 of file itkImageAdaptor.h.

typedef Superclass::SpacingType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SpacingType
inherited

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples.

Definition at line 109 of file itkImageAdaptor.h.

typedef double itk::ImageBase< VImageDimension >::SpacingValueType
inherited

Spacing typedef support. Spacing holds the size of a pixel. The spacing is the geometric distance between image samples. ITK only supports positive spacing value: negative values may cause undesirable results.

Definition at line 128 of file itkImageBase.h.

template<class TImage , class TOutputPixelType >
typedef ImageAdaptor<TImage, Accessor::RGBToLuminancePixelAccessor< typename TImage::PixelType, TOutputPixelType> > itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::Superclass

Definition at line 80 of file itkRGBToLuminanceImageAdaptor.h.

Constructor & Destructor Documentation

template<class TImage , class TOutputPixelType >
itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::RGBToLuminanceImageAdaptor ( )
inlineprotected

Definition at line 91 of file itkRGBToLuminanceImageAdaptor.h.

template<class TImage , class TOutputPixelType >
virtual itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::~RGBToLuminanceImageAdaptor ( )
inlineprotectedvirtual

Definition at line 92 of file itkRGBToLuminanceImageAdaptor.h.

template<class TImage , class TOutputPixelType >
itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::RGBToLuminanceImageAdaptor ( const Self )
private

Member Function Documentation

unsigned long itk::Object::AddObserver ( const EventObject event,
Command cmd 
)
inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver ( const EventObject event,
Command cmd 
) const
inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::Allocate ( )
inlinevirtualinherited

Allocate the image memory. Dimension and Size must be set a priori.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

Definition at line 170 of file itkImageAdaptor.h.

void itk::LightObject::BreakOnError ( )
staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

IndexType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::ComputeIndex ( OffsetValueType  offset) const
inherited

Compute Index given an Offset

virtual void itk::ImageBase< VImageDimension >::ComputeIndexToPhysicalPointMatrices ( )
protectedvirtualinherited

Compute helper matrices used to transform Index coordinates to PhysicalPoint coordinates and back. This method is virtual and will be overloaded in derived classes in order to provide backward compatibility behavior in classes that did not used to take image orientation into account.

OffsetValueType itk::ImageBase< VImageDimension >::ComputeOffset ( const IndexType ind) const
inlineinherited

Compute an offset from the beginning of the buffer for a pixel at the specified index. The index is not checked as to whether it is inside the current buffer, so the computed offset could conceivably be outside the buffer. If bounds checking is needed, one can call ImageRegion::IsInside(ind) on the BufferedRegion prior to calling ComputeOffset.

Definition at line 293 of file itkImageBase.h.

References itk::Index< VIndexDimension >::GetIndex().

void itk::ImageBase< VImageDimension >::ComputeOffsetTable ( )
protectedinherited

Calculate the offsets needed to move from one pixel to the next along a row, column, slice, volume, etc. These offsets are based on the size of the BufferedRegion. This should be called after the BufferedRegion is set.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::CopyInformation ( const DataObject data)
virtualinherited

Copy information from the specified data set. This method is part of the pipeline execution model. By default, a ProcessObject will copy meta-data from the first input to all of its outputs. See ProcessObject::GenerateOutputInformation(). Each subclass of DataObject is responsible for being able to copy whatever meta-data it needs from from another DataObject. ImageBase has more meta-data than its DataObject. Thus, it must provide its own version of CopyInformation() in order to copy the LargestPossibleRegion from the input parameter.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

template<class TImage , class TOutputPixelType >
virtual::itk::LightObject::Pointer itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

void itk::DataObject::DataHasBeenGenerated ( )
inherited

Inform the pipeline mechanism that data has been generated. This method is called by ProcessObject::UpdateOutputData() once the process object has finished generating its data. This essentially marks the DataObject as being updated and ready for use.

Definition at line 428 of file itkDataObject.cxx.

void itk::Object::DebugOff ( ) const
virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const
virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )
virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

void itk::DataObject::DisconnectPipeline ( )
inherited

Separate this data object from the pipeline. This routine disconnects a data object from the upstream pipeline. Hence an Update() from downstream will not propagate back past this data object. To completely isolate this data object from the pipeline, the application must remove this data object from any filters which it is connected as the input.

Definition at line 216 of file itkDataObject.cxx.

virtual const RegionType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetBufferedRegion ( void  ) const
virtualinherited

Get the region object that defines the size and starting index of the region of the image currently loaded in memory. This method overloads the one in ImageBase in order to delegate to the adapted image.

See Also
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

InternalPixelType* itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetBufferPointer ( )
inherited

Return a pointer to the beginning of the buffer. This is used by the image iterator class.

const InternalPixelType* itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetBufferPointer ( ) const
inherited
Command * itk::Object::GetCommand ( unsigned long  tag)
inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::DataObject::GetDataReleased ( ) const
inlineinherited

Get the flag indicating the data has been released.

Definition at line 332 of file itkDataObject.h.

bool itk::Object::GetDebug ( ) const
inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

virtual const DirectionType& itk::ImageBase< VImageDimension >::GetDirection ( void  )
virtualinherited

Get the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next. For ImageBase and Image, the default direction is identity.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >.

virtual const DirectionType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetDirection ( void  ) const
virtualinherited

Get the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next. For ImageBase and Image, the default direction is identity.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

bool itk::DataObject::GetGlobalReleaseDataFlag ( )
staticinherited

Definition at line 189 of file itkDataObject.cxx.

bool itk::Object::GetGlobalWarningDisplay ( )
staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

static unsigned int itk::ImageBase< VImageDimension >::GetImageDimension ( )
inlinestaticinherited

Image dimension. The dimension of an image is fixed at construction.

Definition at line 145 of file itkImageBase.h.

virtual const RegionType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetLargestPossibleRegion ( void  ) const
virtualinherited

Get the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions. This method overloads the one in ImageBase in order to delegate to the adapted image.

See Also
ImageRegion, GetBufferedRegion(), GetRequestedRegion()

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  )
inherited
Returns
A reference to this objects MetaDataDictionary.
Warning
This reference may be changed.

Definition at line 532 of file itkObject.cxx.

References NULL.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData(), itk::Brains2MaskImageIO::CanReadFile(), otb::DataNode< TPrecision, VDimension, TValuePrecision >::CopyFieldList(), otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), otb::Image< TPixel, VImageDimension >::CopyInformation(), itk::GDCMImageIO::GetBodyPart(), itk::GDCMImageIO::GetInstitution(), itk::GDCMImageIO::GetManufacturer(), itk::GDCMImageIO::GetModality(), itk::GDCMImageIO::GetModel(), itk::GDCMImageIO::GetNumberOfSeriesInStudy(), itk::GDCMImageIO::GetNumberOfStudyRelatedSeries(), itk::GDCMImageIO::GetPatientAge(), itk::GDCMImageIO::GetPatientDOB(), itk::GDCMImageIO::GetPatientID(), itk::GDCMImageIO::GetPatientName(), itk::GDCMImageIO::GetPatientSex(), itk::GDCMImageIO::GetScanOptions(), itk::GDCMImageIO::GetStudyDate(), itk::GDCMImageIO::GetStudyDescription(), itk::GDCMImageIO::GetStudyID(), itk::GDCMImageIO::GetValueFromTag(), otb::GDALImageIO::InternalReadImageInformation(), itk::GDCMImageIO::InternalReadImageInformation(), otb::GDALImageIO::InternalWriteImageInformation(), otb::RAMDrivenAdaptativeStreamingManager< TImage >::PrepareStreaming(), itk::DICOMImageIO2::Read(), itk::DICOMImageIO2::ReadImageInformation(), itk::NrrdImageIO::ReadImageInformation(), otb::JPEG2000ImageIO::ReadImageInformation(), itk::MetaImageIO::ReadImageInformation(), itk::VoxBoCUBImageIO::ReadImageInformation(), itk::MRCImageIO::ReadImageInformation(), itk::IPLCommonImageIO::ReadImageInformation(), itk::PhilipsRECImageIO::ReadImageInformation(), itk::AnalyzeImageIO::ReadImageInformation(), itk::Bruker2DSEQImageIO::ReadImageInformation(), otb::ImageMetadataInterfaceBase::SetImage(), itk::NiftiImageIO::SetImageIOMetadataFromNIfTI(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::SetOutputParametersFromImage(), itk::NrrdImageIO::Write(), itk::GDCMImageIO::Write(), and itk::PolygonGroupSpatialObjectXMLFileWriter::WriteFile().

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void  ) const
inherited
Returns
A constant reference to this objects MetaDataDictionary.

Definition at line 543 of file itkObject.cxx.

References NULL.

virtual unsigned long itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetMTime ( void  ) const
virtualinherited

Delegate GetMTime to the Internal Image

Reimplemented from itk::Object.

template<class TImage , class TOutputPixelType >
virtual const char* itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >.

virtual unsigned int itk::ImageBase< VImageDimension >::GetNumberOfComponentsPerPixel ( ) const
virtualinherited

INTERNAL This method is used internally by filters to copy meta-data from the output to the input. Users should not have a need to use this method.

Filters that override the ProcessObject's GenerateOutputInformation() should generally have the following line if they want to propagate meta- data for both Image and VectorImage

outputImage->SetNumberOfComponentsPerPixel(
inputImage->GetNumberOfComponentsPerPixel() )
See Also
ImageBase, VectorImage

Returns/Sets the number of components in the image. Note that for all images this is 1. Even for Image< RGBPixel< T >, 3 >. This is >= 1 only for time-series images such as itk::VectorImage.

const OffsetValueType* itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetOffsetTable ( void  ) const
inherited

Get the OffsetTable from the adapted image

virtual const PointType& itk::ImageBase< VImageDimension >::GetOrigin ( void  )
virtualinherited

Get the origin of the image. The origin is the geometric coordinates of the index (0,0). The value returned is a pointer to a double array. For ImageBase and Image, the default origin is 0.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >.

virtual const PointType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetOrigin ( void  ) const
virtualinherited

Get the origin of the image. The origin is the geometric coordinates of the image origin.

See Also
SetOrigin()

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

virtual const unsigned long& itk::DataObject::GetPipelineMTime ( )
virtualinherited
PixelType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetPixel ( const IndexType index) const
inlineinherited

Get a pixel (read only version)

Definition at line 185 of file itkImageAdaptor.h.

AccessorType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetPixelAccessor ( void  )
inlineinherited

Return the Data Accesor object

Definition at line 273 of file itkImageAdaptor.h.

const AccessorType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetPixelAccessor ( void  ) const
inlineinherited

Return the Data Accesor object

Definition at line 277 of file itkImageAdaptor.h.

PixelContainerPointer itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetPixelContainer ( )
inlineinherited

Return a pointer to the container.

Definition at line 205 of file itkImageAdaptor.h.

const PixelContainer* itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetPixelContainer ( ) const
inlineinherited

Definition at line 208 of file itkImageAdaptor.h.

virtual int itk::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::DataObject::GetReleaseDataFlag ( )
virtualinherited
virtual const RegionType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetRequestedRegion ( void  ) const
virtualinherited

Get the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). This method overloads the one in ImageBase in order to delegate to the adapted image.

See Also
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

SmartPointerForwardReference< ProcessObject > itk::DataObject::GetSource ( void  ) const
inherited

Get the process object that generated this data object. If there is no process object, then the data object has been disconnected from the pipeline, or the data object was created manually. (Note: we cannot use the GetObjectMacro() defined in itkMacro because the mutual dependency of DataObject and ProcessObject causes compile problems. Also, a forward reference smart pointer is returned, not a smart pointer, because of the circular dependency between the process and data object.)

GetSource() returns a SmartPointerForwardReference and not a WeakPointer because it is assumed the code calling GetSource() wants to hold a long term reference to the source.

Definition at line 288 of file itkDataObject.cxx.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

unsigned int itk::DataObject::GetSourceOutputIndex ( ) const
inherited

Which of the source's outputs corresponds to this data object?

Definition at line 296 of file itkDataObject.cxx.

Referenced by itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateOutputRequestedRegion().

virtual const SpacingType& itk::ImageBase< VImageDimension >::GetSpacing ( void  )
virtualinherited

Get the spacing (size of a pixel) `of the image. The spacing is the geometric distance between image samples. The value returned is a pointer to a double array. For ImageBase and Image, the default data spacing is unity.

Reimplemented in itk::ImageAdaptor< TImage, TAccessor >, itk::ImageAdaptor< TImage, Accessor::AsinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SqrtPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, otb::Accessor::VectorImageToASPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::TanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::CosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::VectorToRGBPixelAccessor< TImage::PixelType::ValueType > >, itk::ImageAdaptor< TImage, Accessor::RGBToVectorPixelAccessor< TImage::PixelType::ComponentType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToModulusPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AbsPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ShiftScalePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::SinPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::LogPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToPhasePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::Log10PixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AtanPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToRealPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ComplexToImaginaryPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpNegativePixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::ExpPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::AcosPixelAccessor< TImage::PixelType, TOutputPixelType > >, itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >, and itk::ImageAdaptor< TImage, Accessor::AddPixelAccessor< TImage::PixelType > >.

virtual const SpacingType& itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::GetSpacing ( void  ) const
virtualinherited

Get the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples.

See Also
SetSpacing()

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

unsigned long itk::DataObject::GetUpdateMTime ( ) const
virtualinherited

MTime for the last time this DataObject was generated.

Definition at line 438 of file itkDataObject.cxx.

static void itk::DataObject::GlobalReleaseDataFlagOff ( )
inlinestaticinherited

Definition at line 318 of file itkDataObject.h.

static void itk::DataObject::GlobalReleaseDataFlagOn ( )
inlinestaticinherited

Definition at line 316 of file itkDataObject.h.

static void itk::Object::GlobalWarningDisplayOff ( )
inlinestaticinherited
static void itk::Object::GlobalWarningDisplayOn ( )
inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::Graft ( const DataObject data)
virtualinherited

Graft the data and information from one image to another. This is a convenience method to setup a second image with all the meta information of another image and use the same pixel container. Note that this method is different than just using two SmartPointers to the same image since separate DataObjects are still maintained. This method is similar to ImageSource::GraftOutput(). The implementation in ImageBase simply calls CopyInformation() and copies the region ivars. The implementation here refers to the superclass' implementation and then copies over the pixel container.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

bool itk::Object::HasObserver ( const EventObject event) const
inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::Initialize ( void  )
virtualinherited

Restore the data object to its initial state. This means releasing memory.

Reimplemented from itk::DataObject.

virtual void itk::ImageBase< VImageDimension >::InitializeBufferedRegion ( void  )
protectedvirtualinherited

Restores the buffered region to it's default state This method does not call Modify because Initialization is called by ReleaseData and can not modify the MTime

See Also
ReleaseData, Initialize, SetBufferedRegion
void itk::Object::InvokeEvent ( const EventObject event)
inherited
void itk::Object::InvokeEvent ( const EventObject event) const
inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::Modified ( void  ) const
virtualinherited

Delegate Modified to the Internal Image

Reimplemented from itk::Object.

template<class TImage , class TOutputPixelType >
static Pointer itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::New ( )
static

Method for creation through the object factory.

template<class TImage , class TOutputPixelType >
void itk::RGBToLuminanceImageAdaptor< TImage, TOutputPixelType >::operator= ( const Self )
private
PixelType itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::operator[] ( const IndexType index) const
inlineinherited

Access a pixel. This version can only be an rvalue.

Definition at line 189 of file itkImageAdaptor.h.

virtual void itk::DataObject::PrepareForNewData ( )
inlinevirtualinherited

Setup a DataObject to receive new data. This method is called by the pipeline mechanism on each output of filter that needs to execute. The default implementation is to return a DataObject to its initial state. This may involve releasing previously allocated bulk data. Subclasses of DataObject may want to override this method and/or the Initialize() method if they want a different default behavior (for instance a DataObject might want finer control over its bulk data memory management).

Definition at line 385 of file itkDataObject.h.

void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const
inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers ( std::ostream &  os,
Indent  indent 
) const
protectedinherited

Definition at line 478 of file itkObject.cxx.

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::PropagateRequestedRegion ( void  ) throw (InvalidRequestedRegionError)
virtualinherited

Methods to update the pipeline. Called internally by the pipeline mechanism.

Reimplemented from itk::DataObject.

void itk::DataObject::PropagateResetPipeline ( )
protectedvirtualinherited

Propagate a call to ResetPipeline(). Called only from ProcessObject.

Definition at line 367 of file itkDataObject.cxx.

void itk::Object::Register ( ) const
virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::DataObject::ReleaseData ( )
inherited

Release data back to system to conserve memory resource. Used during pipeline execution. Releasing this data does not make down-stream data invalid, so it does not modify the MTime of this data object.

Definition at line 197 of file itkDataObject.cxx.

virtual void itk::DataObject::ReleaseDataFlagOff ( )
virtualinherited
virtual void itk::DataObject::ReleaseDataFlagOn ( )
virtualinherited
void itk::Object::RemoveAllObservers ( )
inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long  tag)
inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

virtual bool itk::ImageBase< VImageDimension >::RequestedRegionIsOutsideOfTheBufferedRegion ( )
virtualinherited

Determine whether the RequestedRegion is outside of the BufferedRegion. This method returns true if the RequestedRegion is outside the BufferedRegion (true if at least one pixel is outside). This is used by the pipeline mechanism to determine whether a filter needs to re-execute in order to satisfy the current request. If the current RequestedRegion is already inside the BufferedRegion from the previous execution (and the current filter is up to date), then a given filter does not need to re-execute

Reimplemented from itk::DataObject.

void itk::DataObject::ResetPipeline ( )
virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 360 of file itkDataObject.cxx.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetBufferedRegion ( const RegionType region)
virtualinherited

Set the region object that defines the size and starting index of the region of the image currently load in memory.

See Also
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()
virtual void itk::ImageBase< VImageDimension >::SetBufferedRegion ( const RegionType region)
virtualinherited

Set the region object that defines the size and starting index of the region of the image currently loaded in memory.

See Also
ImageRegion, SetLargestPossibleRegion(), SetRequestedRegion()
void itk::Object::SetDebug ( bool  debugFlag) const
inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

virtual void itk::ImageBase< VImageDimension >::SetDirection ( const DirectionType  direction)
virtualinherited

Set the direction cosines of the image. The direction cosines are vectors that point from one pixel to the next.

One row of the matrix indicates the direction cosines of the unit vector that is parallel to the lines of the image grid corresponding to that dimension. For example, and image with Direction matrix

0.866 0.500 -0.500 0.866

has an image grid were the fastest changing index (dimension[0]) walks over a line that in Physical space is oriented parallel to the vector (0.866,0.5). The second fastest changing index (dimension[1]) walks along a line that in Physical space is oriented parallel to the vector (-0.5,0.866)

The vectors whose direction cosines are stored in the Direction matrix, are expected to be orthogonal to each other, and they are expected to form a right handed coordinate system, but this is not checked nor enforced in the itk::ImageBase.

For details, please see:

http://www.itk.org/Wiki/Proposals:Orientation#Some_notes_on_the_DICOM_convention_and_current_ITK_usage

See Also
GetDirection()
virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetDirection ( const DirectionType  direction)
virtualinherited

Set the direction of the image.

void itk::DataObject::SetGlobalReleaseDataFlag ( bool  val)
staticinherited

Turn on/off a flag to control whether every object releases its data after being used by a filter. Being a global flag, it controls the behavior of all DataObjects and ProcessObjects.

Definition at line 177 of file itkDataObject.cxx.

void itk::Object::SetGlobalWarningDisplay ( bool  val)
staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetImage ( TImage *  )
virtualinherited

Set Internal Image

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetLargestPossibleRegion ( const RegionType region)
virtualinherited

Set the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See Also
ImageRegion, SetBufferedRegion(), SetRequestedRegion()
virtual void itk::ImageBase< VImageDimension >::SetLargestPossibleRegion ( const RegionType region)
virtualinherited

Set the region object that defines the size and starting index for the largest possible region this image could represent. This is used in determining how much memory would be needed to load an entire dataset. It is also used to determine boundary conditions.

See Also
ImageRegion, SetBufferedRegion(), SetRequestedRegion()
void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary rhs)
inherited
virtual void itk::ImageBase< VImageDimension >::SetNumberOfComponentsPerPixel ( unsigned  int)
virtualinherited
virtual void itk::ImageBase< VImageDimension >::SetOrigin ( PointType  _arg)
virtualinherited

Set the origin of the image. The origin is the geometric coordinates of the image origin. It is stored internally as double but may be set from float.

See Also
GetOrigin()
virtual void itk::ImageBase< VImageDimension >::SetOrigin ( const double  origin[VImageDimension])
virtualinherited
virtual void itk::ImageBase< VImageDimension >::SetOrigin ( const float  origin[VImageDimension])
virtualinherited
virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetOrigin ( const PointType  values)
virtualinherited

Set the origin of the image.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetOrigin ( const double *  values)
virtualinherited
virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetOrigin ( const float *  values)
virtualinherited
void itk::DataObject::SetPipelineMTime ( unsigned long  time)
inlineinherited

The maximum MTime of all upstream filters and data objects. This does not include the MTime of this data object.

Definition at line 370 of file itkDataObject.h.

Referenced by itk::ProcessObject::UpdateOutputInformation().

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetPixel ( const IndexType index,
const PixelType value 
)
inlineinherited

Set a pixel.

Definition at line 181 of file itkImageAdaptor.h.

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetPixelAccessor ( const AccessorType accessor)
inlineinherited

Sets the Data Accesor object

Definition at line 281 of file itkImageAdaptor.h.

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetPixelContainer ( PixelContainer container)
inherited

Set the container to use. Note that this does not cause the DataObject to be modified.

void itk::Object::SetReferenceCount ( int  ref)
virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

void itk::DataObject::SetReleaseDataFlag ( bool  flag)
inlineinherited

Turn on/off a flag to control whether this object's data is released after being used by a filter.

Definition at line 304 of file itkDataObject.h.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetRequestedRegion ( const RegionType region)
virtualinherited

Set the region object that defines the size and starting index for the region of the image requested.

See Also
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()
virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetRequestedRegion ( DataObject data)
virtualinherited

Set the requested region from this data object to match the requested region of the data object passed in as a parameter. This method implements the API from DataObject. The data object parameter must be castable to an ImageBase.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

virtual void itk::ImageBase< VImageDimension >::SetRequestedRegion ( const RegionType region)
virtualinherited

Set the region object that defines the size and starting index for the region of the image requested (i.e., the region of the image to be operated on by a filter). Setting the RequestedRegion does not cause the object to be modified. This method is called internally by the pipeline and therefore bypasses the modified time calculation.

See Also
ImageRegion, SetLargestPossibleRegion(), SetBufferedRegion()
virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetRequestedRegionToLargestPossibleRegion ( )
virtualinherited

Set the RequestedRegion to the LargestPossibleRegion. This forces a filter to produce all of the output in one execution (i.e. not streaming) on the next call to Update().

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetSpacing ( const SpacingType values)
virtualinherited

Set the spacing (size of a pixel) of the image.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetSpacing ( const double *  values)
virtualinherited
virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::SetSpacing ( const float *  values)
virtualinherited
virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const SpacingType spacing)
virtualinherited

Set the spacing (size of a pixel) of the image. The spacing is the geometric distance between image samples. It is stored internally as double, but may be set from float. These methods also pre-compute the Index to Physical point transforms of the image.

See Also
GetSpacing()
virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const double  spacing[VImageDimension])
virtualinherited
virtual void itk::ImageBase< VImageDimension >::SetSpacing ( const float  spacing[VImageDimension])
virtualinherited
bool itk::DataObject::ShouldIReleaseData ( ) const
inherited

Return flag indicating whether data should be released after use by a filter.

Definition at line 206 of file itkDataObject.cxx.

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::TransformContinuousIndexToPhysicalPoint ( const ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &  index,
Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &  point 
) const
inlineinherited

Get a physical point (in the space which the origin and spacing infomation comes from) from a continuous index (in the index space)

See Also
Transform

Definition at line 328 of file itkImageAdaptor.h.

void itk::ImageBase< VImageDimension >::TransformContinuousIndexToPhysicalPoint ( const ContinuousIndex< TCoordRep, VImageDimension > &  index,
Point< TCoordRep, VImageDimension > &  point 
) const
inlineinherited

Get a physical point (in the space which the origin and spacing infomation comes from) from a continuous index (in the index space)

See Also
Transform

Definition at line 436 of file itkImageBase.h.

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::TransformIndexToPhysicalPoint ( const IndexType index,
Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &  point 
) const
inlineinherited

Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)

See Also
Transform

Definition at line 343 of file itkImageAdaptor.h.

void itk::ImageBase< VImageDimension >::TransformIndexToPhysicalPoint ( const IndexType index,
Point< TCoordRep, VImageDimension > &  point 
) const
inlineinherited

Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)

See Also
Transform

Definition at line 467 of file itkImageBase.h.

void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::TransformLocalVectorToPhysicalVector ( const FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  inputGradient,
FixedArray< TCoordRep, itkGetStaticConstMacro(ImageDimension) > &  outputGradient 
) const
inlineinherited

Definition at line 352 of file itkImageAdaptor.h.

void itk::ImageBase< VImageDimension >::TransformLocalVectorToPhysicalVector ( const FixedArray< TCoordRep, VImageDimension > &  inputGradient,
FixedArray< TCoordRep, VImageDimension > &  outputGradient 
) const
inlineinherited

Get a physical point (in the space which the origin and spacing infomation comes from) from a discrete index (in the index space)

See Also
Transform Take a vector or covariant vector that has been computed in the coordinate system parallel to the image grid and rotate it by the direction cosines in order to get it in terms of the coordinate system of the image acquisition device. This implementation in the OrientedImage multiply the array (vector or covariant vector) by the matrix of Direction Cosines. The arguments of the method are of type FixedArray to make possible to use this method with both Vector and CovariantVector. The Method is implemented differently in the itk::Image.
Image

Definition at line 501 of file itkImageBase.h.

bool itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::TransformPhysicalPointToContinuousIndex ( const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &  point,
ContinuousIndex< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &  index 
) const
inlineinherited

Get the continuous index from a physical point.

Returns true if the resulting index is within the image, false otherwise.

See Also
Transform

Definition at line 301 of file itkImageAdaptor.h.

bool itk::ImageBase< VImageDimension >::TransformPhysicalPointToContinuousIndex ( const Point< TCoordRep, VImageDimension > &  point,
ContinuousIndex< TCoordRep, VImageDimension > &  index 
) const
inlineinherited

Get the continuous index from a physical point.

Returns true if the resulting index is within the image, false otherwise.

See Also
Transform

Definition at line 408 of file itkImageBase.h.

bool itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::TransformPhysicalPointToIndex ( const Point< TCoordRep, itkGetStaticConstMacro(ImageDimension)> &  point,
IndexType index 
) const
inlineinherited

Get the index (discrete) from a physical point. Floating point index results are truncated to integers. Returns true if the resulting index is within the image, false otherwise

See Also
Transform

Definition at line 315 of file itkImageAdaptor.h.

bool itk::ImageBase< VImageDimension >::TransformPhysicalPointToIndex ( const Point< TCoordRep, VImageDimension > &  point,
IndexType index 
) const
inlineinherited

Get the index (discrete) of a voxel from a physical point. Floating point index results are rounded to integers if ITK_USE_CENTERED_PIXEL_COORDINATES_CONSISTENTLY is on and truncated otherwise. Returns true if the resulting index is within the image, false otherwise

See Also
Transform

Definition at line 378 of file itkImageBase.h.

void itk::Object::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::Update ( void  )
virtualinherited

Return the Data Accesor object

Reimplemented from itk::DataObject.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::UpdateOutputData ( void  )
virtualinherited

Overriden from base class to check if the requested image region has zero pixels.

This is needed so that filters can set an input's requested region to zero, to indicate that it does not need to be updated or executed.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

virtual void itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::UpdateOutputInformation ( void  )
virtualinherited

Methods to update the pipeline. Called internally by the pipeline mechanism.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

virtual bool itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::VerifyRequestedRegion ( )
virtualinherited

Verify that the RequestedRegion is within the LargestPossibleRegion. If the RequestedRegion is not within the LargestPossibleRegion, then the filter cannot possible satisfy the request. This method returns true if the request can be satisfied and returns fails if the request cannot. This method is used by PropagateRequestedRegion(). PropagateRequestedRegion() throws a InvalidRequestedRegionError exception is the requested region is not within the LargestPossibleRegion.

Reimplemented from itk::ImageBase< ::itk::GetImageDimension< TImage >::ImageDimension >.

Member Data Documentation

const unsigned int itk::ImageAdaptor< TImage, Accessor::RGBToLuminancePixelAccessor< TImage::PixelType, TOutputPixelType > >::ImageDimension
staticinherited

Dimension of the image. This constant is used by functions that are templated over image type (as opposed to being templated over pixel type and dimension) when they need compile time access to the dimension of the image.

Definition at line 55 of file itkImageAdaptor.h.

DirectionType itk::ImageBase< VImageDimension >::m_Direction
protectedinherited

Definition at line 638 of file itkImageBase.h.

DirectionType itk::ImageBase< VImageDimension >::m_IndexToPhysicalPoint
protectedinherited

Matrices intended to help with the conversion of Index coordinates to PhysicalPoint coordinates

Definition at line 642 of file itkImageBase.h.

PointType itk::ImageBase< VImageDimension >::m_Origin
protectedinherited

Definition at line 637 of file itkImageBase.h.

DirectionType itk::ImageBase< VImageDimension >::m_PhysicalPointToIndex
protectedinherited

Definition at line 643 of file itkImageBase.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

SpacingType itk::ImageBase< VImageDimension >::m_Spacing
protectedinherited

Origin and spacing of physical coordinates. This variables are protected for efficiency. They are referenced frequently by inner loop calculations.

Definition at line 636 of file itkImageBase.h.


The documentation for this class was generated from the following file:

Generated at Sun May 19 2013 02:28:25 for Orfeo Toolbox with doxygen 1.8.3.1