SimpleITK
2.1.0
|
Shift and scale the pixels in an image. More...
#include <sitkShiftScaleImageFilter.h>
Public Types | |
using | PixelIDTypeList = BasicPixelIDTypeList |
using | Self = ShiftScaleImageFilter |
Public Types inherited from itk::simple::ImageFilter | |
using | Self = ImageFilter |
Public Types inherited from itk::simple::ProcessObject | |
using | Self = ProcessObject |
Public Member Functions | |
Image | Execute (const Image &image1) |
std::string | GetName () const |
PixelIDValueEnum | GetOutputPixelType () const |
Get the output pixel type. More... | |
int64_t | GetOverflowCount () const |
double | GetScale () const |
double | GetShift () const |
int64_t | GetUnderflowCount () const |
Self & | SetOutputPixelType (PixelIDValueEnum OutputPixelType) |
Set the output pixel type, if sitkUnknown then the input type is used. More... | |
Self & | SetScale (double Scale) |
Self & | SetShift (double Shift) |
ShiftScaleImageFilter () | |
std::string | ToString () const |
virtual | ~ShiftScaleImageFilter () |
Public Member Functions inherited from itk::simple::ImageFilter | |
ImageFilter () | |
virtual | ~ImageFilter ()=0 |
Public Member Functions inherited from itk::simple::ProcessObject | |
virtual void | Abort () |
virtual int | AddCommand (itk::simple::EventEnum event, const std::function< void()> &func) |
Directly add a callback to observe an event. More... | |
virtual int | AddCommand (itk::simple::EventEnum event, itk::simple::Command &cmd) |
Add a Command Object to observer the event. More... | |
virtual float | GetProgress () const |
An Active Measurement of the progress of execution. More... | |
virtual bool | HasCommand (itk::simple::EventEnum event) const |
Query of this object has any registered commands for event. More... | |
ProcessObject () | |
virtual void | RemoveAllCommands () |
Remove all registered commands. More... | |
virtual | ~ProcessObject () |
virtual void | DebugOn () |
virtual void | DebugOff () |
virtual bool | GetDebug () const |
virtual void | SetDebug (bool debugFlag) |
virtual void | SetNumberOfThreads (unsigned int n) |
virtual unsigned int | GetNumberOfThreads () const |
virtual void | SetNumberOfWorkUnits (unsigned int n) |
virtual unsigned int | GetNumberOfWorkUnits () const |
Private Types | |
using | MemberFunctionType = Image(Self::*)(const Image &image1) |
Private Member Functions | |
template<class TImageType1 , class TImageType2 > | |
Image | DualExecuteInternal (const Image &image1) |
template<class TImageType1 , class TImageType2 > | |
Image | DualExecuteInternalVector (const Image &image1) |
Private Attributes | |
std::unique_ptr< detail::DualMemberFunctionFactory< MemberFunctionType > > | m_DualMemberFactory |
PixelIDValueEnum | m_OutputPixelType {itk::simple::sitkUnknown} |
int64_t | m_OverflowCount {0u} |
double | m_Scale {1.0} |
double | m_Shift {0} |
int64_t | m_UnderflowCount {0u} |
Friends | |
struct | detail::DualExecuteInternalAddressor< MemberFunctionType > |
struct | detail::DualExecuteInternalVectorAddressor< MemberFunctionType > |
Additional Inherited Members | |
Static Public Member Functions inherited from itk::simple::ProcessObject | |
static bool | GetGlobalDefaultDebug () |
static void | GlobalDefaultDebugOff () |
static void | GlobalDefaultDebugOn () |
static void | SetGlobalDefaultDebug (bool debugFlag) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static void | SetGlobalWarningDisplay (bool flag) |
static bool | GetGlobalWarningDisplay () |
static double | GetGlobalDefaultCoordinateTolerance () |
Access the global tolerance to determine congruent spaces. More... | |
static void | SetGlobalDefaultCoordinateTolerance (double) |
Access the global tolerance to determine congruent spaces. More... | |
static double | GetGlobalDefaultDirectionTolerance () |
Access the global tolerance to determine congruent spaces. More... | |
static void | SetGlobalDefaultDirectionTolerance (double) |
Access the global tolerance to determine congruent spaces. More... | |
static bool | SetGlobalDefaultThreader (const std::string &threader) |
Set/Get the default threader used for process objects. More... | |
static std::string | GetGlobalDefaultThreader () |
Set/Get the default threader used for process objects. More... | |
static void | SetGlobalDefaultNumberOfThreads (unsigned int n) |
static unsigned int | GetGlobalDefaultNumberOfThreads () |
Set/Get the default threader used for process objects. More... | |
Protected Member Functions inherited from itk::simple::ImageFilter | |
void | CheckImageMatchingDimension (const Image &image1, const Image &image2, const std::string &image2Name) |
void | CheckImageMatchingPixelType (const Image &image1, const Image &image2, const std::string &image2Name) |
void | CheckImageMatchingSize (const Image &image1, const Image &image2, const std::string &image2Name) |
Protected Member Functions inherited from itk::simple::ProcessObject | |
virtual unsigned long | AddITKObserver (const itk::EventObject &, itk::Command *) |
virtual itk::ProcessObject * | GetActiveProcess () |
virtual void | OnActiveProcessDelete () |
virtual void | onCommandDelete (const itk::simple::Command *cmd) noexcept |
virtual void | PreUpdate (itk::ProcessObject *p) |
virtual void | RemoveITKObserver (EventCommand &e) |
Protected Member Functions inherited from itk::simple::NonCopyable | |
NonCopyable ()=default | |
NonCopyable (const NonCopyable &)=delete | |
NonCopyable & | operator= (const NonCopyable &)=delete |
Static Protected Member Functions inherited from itk::simple::ImageFilter | |
template<class TImageType > | |
static void | FixNonZeroIndex (TImageType *img) |
Static Protected Member Functions inherited from itk::simple::ProcessObject | |
template<class TImageType > | |
static TImageType::ConstPointer | CastImageToITK (const Image &img) |
template<class TPixelType , unsigned int VImageDimension, unsigned int VLength, template< typename, unsigned int > class TVector> | |
static Image | CastITKToImage (itk::Image< TVector< TPixelType, VLength >, VImageDimension > *img) |
template<class TImageType > | |
static Image | CastITKToImage (TImageType *img) |
static const itk::EventObject & | GetITKEventObject (EventEnum e) |
template<typename T > | |
static std::ostream & | ToStringHelper (std::ostream &os, const T &v) |
static std::ostream & | ToStringHelper (std::ostream &os, const char &v) |
static std::ostream & | ToStringHelper (std::ostream &os, const signed char &v) |
static std::ostream & | ToStringHelper (std::ostream &os, const unsigned char &v) |
Shift and scale the pixels in an image.
ShiftScaleImageFilter shifts the input pixel by Shift (default 0.0) and then scales the pixel by Scale (default 1.0). All computations are performed in the precision of the input pixel's RealType. Before assigning the computed value to the output pixel, the value is clamped at the NonpositiveMin and max of the pixel type.
Definition at line 43 of file sitkShiftScaleImageFilter.h.
|
private |
Setup for member function dispatching
Definition at line 119 of file sitkShiftScaleImageFilter.h.
Define the pixels types supported by this filter
Definition at line 55 of file sitkShiftScaleImageFilter.h.
Definition at line 45 of file sitkShiftScaleImageFilter.h.
|
virtual |
Destructor
itk::simple::ShiftScaleImageFilter::ShiftScaleImageFilter | ( | ) |
Default Constructor that takes no arguments and initializes default parameters
|
private |
|
private |
Execute the filter on the input image
|
inlinevirtual |
Name of this class
Implements itk::simple::ProcessObject.
Definition at line 106 of file sitkShiftScaleImageFilter.h.
|
inline |
Get the output pixel type.
Definition at line 87 of file sitkShiftScaleImageFilter.h.
|
inline |
Get the number of pixels that underflowed and overflowed.
This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.
Definition at line 102 of file sitkShiftScaleImageFilter.h.
|
inline |
Set/Get the amount to Scale each Pixel. The Scale is applied after the Shift.
Definition at line 77 of file sitkShiftScaleImageFilter.h.
|
inline |
Set/Get the amount to Shift each Pixel. The shift is followed by a Scale.
Definition at line 67 of file sitkShiftScaleImageFilter.h.
|
inline |
Get the number of pixels that underflowed and overflowed.
This is a measurement. Its value is updated in the Execute methods, so the value will only be valid after an execution.
Definition at line 94 of file sitkShiftScaleImageFilter.h.
|
inline |
Set the output pixel type, if sitkUnknown then the input type is used.
Definition at line 82 of file sitkShiftScaleImageFilter.h.
|
inline |
Set/Get the amount to Scale each Pixel. The Scale is applied after the Shift.
Definition at line 72 of file sitkShiftScaleImageFilter.h.
|
inline |
Set/Get the amount to Shift each Pixel. The shift is followed by a Scale.
Definition at line 62 of file sitkShiftScaleImageFilter.h.
|
virtual |
Print ourselves out
Reimplemented from itk::simple::ProcessObject.
|
friend |
Definition at line 121 of file sitkShiftScaleImageFilter.h.
|
friend |
Definition at line 123 of file sitkShiftScaleImageFilter.h.
|
private |
Definition at line 126 of file sitkShiftScaleImageFilter.h.
|
private |
Definition at line 134 of file sitkShiftScaleImageFilter.h.
|
private |
Definition at line 139 of file sitkShiftScaleImageFilter.h.
|
private |
Definition at line 132 of file sitkShiftScaleImageFilter.h.
|
private |
Definition at line 130 of file sitkShiftScaleImageFilter.h.
|
private |
Definition at line 137 of file sitkShiftScaleImageFilter.h.