Package org.itk.simple
Class ShiftScaleImageFilter
java.lang.Object
org.itk.simple.ProcessObject
org.itk.simple.ImageFilter
org.itk.simple.ShiftScaleImageFilter
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.
See:
itk::simple::ShiftScale for the procedural interface
itk::ShiftScaleImageFilter for the Doxygen on the original ITK class.
C++ includes: sitkShiftScaleImageFilter.h
-
Field Summary
Fields inherited from class org.itk.simple.ProcessObject
swigCMemOwn
-
Constructor Summary
ConstructorsModifierConstructorDescriptionitk::simple::ShiftScaleImageFilter::ShiftScaleImageFilter() Default Constructor that takes no arguments and initializes default parametersprotected
ShiftScaleImageFilter
(long cPtr, boolean cMemoryOwn) -
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
virtual itk::simple::ShiftScaleImageFilter::~ShiftScaleImageFilter() DestructorImage itk::simple::ShiftScaleImageFilter::Execute(const Image &image1) Execute the filter on the input imageprotected void
finalize()
protected static long
getName()
std::string itk::simple::ShiftScaleImageFilter::GetName() const Name of this classPixelIDValueEnum itk::simple::ShiftScaleImageFilter::GetOutputPixelType() const Get the output pixel type.int
int64_t itk::simple::ShiftScaleImageFilter::GetOverflowCount() const Get the number of pixels that underflowed and overflowed.double
getScale()
double itk::simple::ShiftScaleImageFilter::GetScale() const Set/Get the amount to Scale each Pixel.double
getShift()
double itk::simple::ShiftScaleImageFilter::GetShift() const Set/Get the amount to Shift each Pixel.int
int64_t itk::simple::ShiftScaleImageFilter::GetUnderflowCount() const Get the number of pixels that underflowed and overflowed.void
setOutputPixelType
(PixelIDValueEnum OutputPixelType) Self& itk::simple::ShiftScaleImageFilter::SetOutputPixelType(PixelIDValueEnum OutputPixelType) Set the output pixel type, if sitkUnknown then the input type is used.void
setScale
(double Scale) Self& itk::simple::ShiftScaleImageFilter::SetScale(double Scale) Set/Get the amount to Scale each Pixel.void
setShift
(double Shift) Self& itk::simple::ShiftScaleImageFilter::SetShift(double Shift) Set/Get the amount to Shift each Pixel.protected static long
toString()
std::string itk::simple::ShiftScaleImageFilter::ToString() const Print ourselves outMethods inherited from class org.itk.simple.ImageFilter
getCPtr, swigRelease
Methods inherited from class org.itk.simple.ProcessObject
abort, addCommand, debugOff, debugOn, getCPtr, getDebug, getGlobalDefaultCoordinateTolerance, getGlobalDefaultDebug, getGlobalDefaultDirectionTolerance, getGlobalDefaultNumberOfThreads, getGlobalDefaultThreader, getGlobalWarningDisplay, getNumberOfThreads, getNumberOfWorkUnits, getProgress, globalDefaultDebugOff, globalDefaultDebugOn, globalWarningDisplayOff, globalWarningDisplayOn, hasCommand, removeAllCommands, setDebug, setGlobalDefaultCoordinateTolerance, setGlobalDefaultDebug, setGlobalDefaultDirectionTolerance, setGlobalDefaultNumberOfThreads, setGlobalDefaultThreader, setGlobalWarningDisplay, setNumberOfThreads, setNumberOfWorkUnits, swigRelease
-
Constructor Details
-
ShiftScaleImageFilter
protected ShiftScaleImageFilter(long cPtr, boolean cMemoryOwn) -
ShiftScaleImageFilter
public ShiftScaleImageFilter()itk::simple::ShiftScaleImageFilter::ShiftScaleImageFilter() Default Constructor that takes no arguments and initializes default parameters
-
-
Method Details
-
getCPtr
-
swigRelease
-
finalize
protected void finalize()- Overrides:
finalize
in classImageFilter
-
delete
public void delete()virtual itk::simple::ShiftScaleImageFilter::~ShiftScaleImageFilter() Destructor- Overrides:
delete
in classImageFilter
-
setShift
public void setShift(double Shift) Self& itk::simple::ShiftScaleImageFilter::SetShift(double Shift) Set/Get the amount to Shift each Pixel. The shift is followed by a Scale. -
getShift
public double getShift()double itk::simple::ShiftScaleImageFilter::GetShift() const Set/Get the amount to Shift each Pixel. The shift is followed by a Scale. -
setScale
public void setScale(double Scale) Self& itk::simple::ShiftScaleImageFilter::SetScale(double Scale) Set/Get the amount to Scale each Pixel. The Scale is applied after the Shift. -
getScale
public double getScale()double itk::simple::ShiftScaleImageFilter::GetScale() const Set/Get the amount to Scale each Pixel. The Scale is applied after the Shift. -
setOutputPixelType
Self& itk::simple::ShiftScaleImageFilter::SetOutputPixelType(PixelIDValueEnum OutputPixelType) Set the output pixel type, if sitkUnknown then the input type is used. -
getOutputPixelType
PixelIDValueEnum itk::simple::ShiftScaleImageFilter::GetOutputPixelType() const Get the output pixel type. -
getUnderflowCount
public int getUnderflowCount()int64_t itk::simple::ShiftScaleImageFilter::GetUnderflowCount() const 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. -
getOverflowCount
public int getOverflowCount()int64_t itk::simple::ShiftScaleImageFilter::GetOverflowCount() const 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. -
getName
std::string itk::simple::ShiftScaleImageFilter::GetName() const Name of this class- Overrides:
getName
in classProcessObject
-
toString
std::string itk::simple::ShiftScaleImageFilter::ToString() const Print ourselves out- Overrides:
toString
in classProcessObject
-
execute
Image itk::simple::ShiftScaleImageFilter::Execute(const Image &image1) Execute the filter on the input image
-