ITK
4.9.0
Insight Segmentation and Registration Toolkit
|
#include <itkMaskImageFilter.h>
Mask an image with a mask.
This class is templated over the types of the input image type, the mask image type and the type of the output image. Numeric conversions (castings) are done by the C++ defaults.
The pixel type of the input 2 image must have a valid definition of the operator != with zero. This condition is required because internally this filter will perform the operation
The pixel from the input 1 is cast to the pixel type of the output image.
Note that the input and the mask images must be of the same size.
Definition at line 146 of file itkMaskImageFilter.h.
Public Member Functions | |
void | BeforeThreadedGenerateData () override |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
const TMaskImage::PixelType & | GetMaskingValue () const |
virtual const char * | GetNameOfClass () const |
const TOutputImage::PixelType & | GetOutsideValue () const |
typedef (Concept::EqualityComparable< typename TMaskImage::PixelType >) MaskEqualityComparableCheck | |
typedef (Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType >) InputConvertibleToOutputCheck | |
void | SetMaskImage (const MaskImageType *maskImage) |
const MaskImageType * | GetMaskImage () |
void | SetOutsideValue (const typename TOutputImage::PixelType &outsideValue) |
void | SetMaskingValue (const typename TMaskImage::PixelType &maskingValue) |
Public Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > > | |
virtual ::itk::LightObject::Pointer | CreateAnother () const |
virtual const Input1ImagePixelType & | GetConstant1 () const |
virtual const Input2ImagePixelType & | GetConstant2 () const |
FunctorType & | GetFunctor () |
const FunctorType & | GetFunctor () const |
virtual void | SetConstant1 (const Input1ImagePixelType &input1) |
typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(InputImage2Dimension) >) SameDimensionCheck1 | |
typedef (Concept::SameDimension< itkGetStaticConstMacro(InputImage1Dimension), itkGetStaticConstMacro(OutputImageDimension) >) SameDimensionCheck2 | |
virtual void | SetInput1 (const TInputImage *image1) |
virtual void | SetInput1 (const DecoratedInput1ImagePixelType *input1) |
virtual void | SetInput1 (const Input1ImagePixelType &input1) |
virtual void | SetInput2 (const TMaskImage *image2) |
virtual void | SetInput2 (const DecoratedInput2ImagePixelType *input2) |
virtual void | SetInput2 (const Input2ImagePixelType &input2) |
virtual void | SetConstant2 (const Input2ImagePixelType &input2) |
void | SetConstant (Input2ImagePixelType ct) |
const Input2ImagePixelType & | GetConstant () const |
void | SetFunctor (const FunctorType &functor) |
Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage > | |
virtual bool | CanRunInPlace () const |
virtual void | SetInPlace (bool _arg) |
virtual bool | GetInPlace () const |
virtual void | InPlaceOn () |
virtual void | InPlaceOff () |
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage > | |
const InputImageType * | GetInput () const |
const InputImageType * | GetInput (unsigned int idx) const |
virtual void | PopBackInput () override |
virtual void | PopFrontInput () override |
virtual void | PushBackInput (const InputImageType *image) |
virtual void | PushFrontInput (const InputImageType *image) |
virtual void | SetInput (const InputImageType *image) |
virtual void | SetInput (unsigned int, const TInputImage *image) |
virtual void | SetCoordinateTolerance (double _arg) |
virtual double | GetCoordinateTolerance () const |
virtual void | SetDirectionTolerance (double _arg) |
virtual double | GetDirectionTolerance () const |
Public Member Functions inherited from itk::ImageSource< TOutputImage > | |
OutputImageType * | GetOutput (unsigned int idx) |
virtual void | GraftNthOutput (unsigned int idx, DataObject *output) |
virtual void | GraftOutput (const DataObjectIdentifierType &key, DataObject *output) |
OutputImageType * | GetOutput () |
const OutputImageType * | GetOutput () const |
virtual void | GraftOutput (DataObject *output) |
virtual ProcessObject::DataObjectPointer | MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override |
virtual ProcessObject::DataObjectPointer | MakeOutput (const ProcessObject::DataObjectIdentifierType &) override |
Public Member Functions inherited from itk::ProcessObject | |
virtual void | AbortGenerateDataOff () |
virtual void | AbortGenerateDataOn () |
virtual void | EnlargeOutputRequestedRegion (DataObject *) |
virtual const bool & | GetAbortGenerateData () const |
DataObjectPointerArray | GetIndexedInputs () |
DataObjectPointerArray | GetIndexedOutputs () |
NameArray | GetInputNames () const |
DataObjectPointerArray | GetInputs () |
MultiThreader * | GetMultiThreader () const |
DataObjectPointerArraySizeType | GetNumberOfIndexedInputs () const |
DataObjectPointerArraySizeType | GetNumberOfIndexedOutputs () const |
DataObjectPointerArraySizeType | GetNumberOfInputs () const |
DataObjectPointerArraySizeType | GetNumberOfOutputs () const |
virtual DataObjectPointerArraySizeType | GetNumberOfValidRequiredInputs () const |
NameArray | GetOutputNames () const |
DataObjectPointerArray | GetOutputs () |
virtual const float & | GetProgress () const |
NameArray | GetRequiredInputNames () const |
bool | HasInput (const DataObjectIdentifierType &key) const |
bool | HasOutput (const DataObjectIdentifierType &key) const |
virtual void | PrepareOutputs () |
virtual void | PropagateRequestedRegion (DataObject *output) |
virtual void | ResetPipeline () |
virtual void | SetAbortGenerateData (bool _arg) |
virtual void | Update () |
virtual void | UpdateLargestPossibleRegion () |
virtual void | UpdateOutputData (DataObject *output) |
virtual void | UpdateOutputInformation () |
void | UpdateProgress (float progress) |
void | SetProgress (float progress) |
virtual void | SetReleaseDataFlag (bool flag) |
virtual bool | GetReleaseDataFlag () const |
void | ReleaseDataFlagOn () |
void | ReleaseDataFlagOff () |
virtual void | SetReleaseDataBeforeUpdateFlag (bool _arg) |
virtual const bool & | GetReleaseDataBeforeUpdateFlag () const |
virtual void | ReleaseDataBeforeUpdateFlagOn () |
virtual void | ReleaseDataBeforeUpdateFlagOff () |
virtual void | SetNumberOfThreads (ThreadIdType _arg) |
virtual const ThreadIdType & | GetNumberOfThreads () const |
Public Member Functions inherited from itk::Object | |
unsigned long | AddObserver (const EventObject &event, Command *) |
unsigned long | AddObserver (const EventObject &event, Command *) const |
virtual void | DebugOff () const |
virtual void | DebugOn () const |
Command * | GetCommand (unsigned long tag) |
bool | GetDebug () const |
MetaDataDictionary & | GetMetaDataDictionary () |
const MetaDataDictionary & | GetMetaDataDictionary () const |
virtual ModifiedTimeType | GetMTime () const |
virtual const TimeStamp & | GetTimeStamp () const |
bool | HasObserver (const EventObject &event) const |
void | InvokeEvent (const EventObject &) |
void | InvokeEvent (const EventObject &) const |
virtual void | Modified () const |
virtual void | Register () const override |
void | RemoveAllObservers () |
void | RemoveObserver (unsigned long tag) |
void | SetDebug (bool debugFlag) const |
void | SetMetaDataDictionary (const MetaDataDictionary &rhs) |
virtual void | SetReferenceCount (int) override |
virtual void | UnRegister () const noexceptoverride |
virtual void | SetObjectName (std::string _arg) |
virtual const std::string & | GetObjectName () const |
Public Member Functions inherited from itk::LightObject | |
virtual void | Delete () |
virtual int | GetReferenceCount () const |
itkCloneMacro (Self) | |
void | Print (std::ostream &os, Indent indent=0) const |
Static Public Member Functions | |
static Pointer | New () |
Static Public Member Functions inherited from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > > | |
static Pointer | New () |
Static Public Member Functions inherited from itk::Object | |
static bool | GetGlobalWarningDisplay () |
static void | GlobalWarningDisplayOff () |
static void | GlobalWarningDisplayOn () |
static Pointer | New () |
static void | SetGlobalWarningDisplay (bool flag) |
Static Public Member Functions inherited from itk::LightObject | |
static void | BreakOnError () |
static Pointer | New () |
Private Member Functions | |
template<typename TPixelType > | |
void | CheckOutsideValue (const TPixelType *) |
template<typename TValue > | |
void | CheckOutsideValue (const VariableLengthVector< TValue > *) |
MaskImageFilter (const Self &) ITK_DELETE_FUNCTION | |
void | operator= (const Self &) ITK_DELETE_FUNCTION |
typedef SmartPointer< const Self > itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::ConstPointer |
Definition at line 166 of file itkMaskImageFilter.h.
typedef TMaskImage itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::MaskImageType |
Typedefs
Definition at line 173 of file itkMaskImageFilter.h.
typedef SmartPointer< Self > itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Pointer |
Definition at line 165 of file itkMaskImageFilter.h.
typedef MaskImageFilter itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Self |
Standard class typedefs.
Definition at line 157 of file itkMaskImageFilter.h.
typedef BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< typename TInputImage::PixelType, typename TMaskImage::PixelType, typename TOutputImage::PixelType > > itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::Superclass |
Definition at line 163 of file itkMaskImageFilter.h.
|
inlineprotected |
Definition at line 243 of file itkMaskImageFilter.h.
|
inlineprotectedvirtual |
Definition at line 244 of file itkMaskImageFilter.h.
|
private |
|
inlineoverridevirtual |
If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.
Reimplemented from itk::ImageSource< TOutputImage >.
Definition at line 226 of file itkMaskImageFilter.h.
References itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue().
|
inlineprivate |
Definition at line 257 of file itkMaskImageFilter.h.
Referenced by itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::BeforeThreadedGenerateData().
|
inlineprivate |
Definition at line 260 of file itkMaskImageFilter.h.
References itk::VariableLengthVector< TValue >::Fill(), itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >::GetFunctor(), itk::ImageSource< TOutputImage >::GetOutput(), itk::Functor::MaskInput< TInput, TMask, TOutput >::GetOutsideValue(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue(), itk::VariableLengthVector< TValue >::GetSize(), and itk::Functor::MaskInput< TInput, TMask, TOutput >::SetOutsideValue().
|
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.
|
inline |
Set/Get the mask image. Pixels set in the mask image will retain the original value of the input image while pixels not set in the mask will be set to the "OutsideValue".
Definition at line 187 of file itkMaskImageFilter.h.
References itk::ProcessObject::GetInput().
|
inline |
Method to get the masking value of the mask.
Definition at line 221 of file itkMaskImageFilter.h.
References itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >::GetFunctor(), and itk::Functor::MaskInput< TInput, TMask, TOutput >::GetMaskingValue().
Referenced by itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetMaskingValue().
|
virtual |
Runtime information support.
Reimplemented from itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >.
|
inline |
Definition at line 204 of file itkMaskImageFilter.h.
References itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >::GetFunctor(), and itk::Functor::MaskInput< TInput, TMask, TOutput >::GetOutsideValue().
Referenced by itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::CheckOutsideValue(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::PrintSelf(), and itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::SetOutsideValue().
|
static |
Method for creation through the object factory.
|
private |
|
inlineoverrideprotectedvirtual |
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.
Reimplemented from itk::InPlaceImageFilter< TInputImage, TOutputImage >.
Definition at line 246 of file itkMaskImageFilter.h.
References itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue(), and itk::InPlaceImageFilter< TInputImage1, TOutputImage >::PrintSelf().
|
inline |
Set/Get the mask image. Pixels set in the mask image will retain the original value of the input image while pixels not set in the mask will be set to the "OutsideValue".
Definition at line 182 of file itkMaskImageFilter.h.
References itk::ProcessObject::SetNthInput().
|
inline |
Method to explicitly set the masking value of the mask. Defaults to 0
Definition at line 210 of file itkMaskImageFilter.h.
References itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >::GetFunctor(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetMaskingValue(), itk::Object::Modified(), and itk::Functor::MaskInput< TInput, TMask, TOutput >::SetMaskingValue().
|
inline |
Method to explicitly set the outside value of the mask. Defaults to 0
Definition at line 194 of file itkMaskImageFilter.h.
References itk::BinaryFunctorImageFilter< TInputImage, TMaskImage, TOutputImage, Functor::MaskInput< TInputImage::PixelType, TMaskImage::PixelType, TOutputImage::PixelType > >::GetFunctor(), itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::GetOutsideValue(), itk::Object::Modified(), itk::Math::NotExactlyEquals(), and itk::Functor::MaskInput< TInput, TMask, TOutput >::SetOutsideValue().
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef | ( | Concept::EqualityComparable< typename TMaskImage::PixelType > | ) |
This class requires MaskEqualityComparableCheck in the form of ( Concept::EqualityComparable< typename TMaskImage::PixelType > )
itk::MaskImageFilter< TInputImage, TMaskImage, TOutputImage >::typedef | ( | Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > | ) |
This class requires InputConvertibleToOutputCheck in the form of ( Concept::Convertible< typename TInputImage::PixelType, typename TOutputImage::PixelType > )