Two-dimensional image with scalar pixel values. More...

#include <cmtkScalarImage.h>

Collaboration diagram for cmtk::ScalarImage:

Public Types
typedef ScalarImage	Self
	This class.
typedef SmartPointer< Self >	SmartPtr
	Smart pointer to ScalarImage.
typedef SmartConstPointer< Self >	SmartConstPtr
	Smart pointer to const ScalarImage.
typedef Region< 2, int >	RegionType
	Region type.
typedef RegionType::IndexType	IndexType
	Pixel index type.
typedef FixedVector < 3, Types::Coordinate >	SpaceVectorType
	Space vector type.
Public Member Functions
	ScalarImage ()
	Default constructor creates empty image.
	ScalarImage (const int dimsx, const int dimsy, const int numberOfFrames=1)
	Constructor with separate x and y dimensions.
	ScalarImage (const ScalarImage &source, const int roiFrom=NULL, const int roiTo=NULL)
	Get ROI as sub-image.
	ScalarImage (const ScalarImage &other, const Self::RegionType &roi)
	Get ROI as sub-image.
virtual	~ScalarImage ()
	Virtual destructor.
virtual void	SetDims (const Self::IndexType &dims)
	Set dimensions.
const Self::IndexType	GetDims () const
	Get dimensions.
virtual ScalarImage *	InterpolateFrom (const ScalarImage grid, const CoordinateMatrix3x3 matrix, const cmtk::Interpolators::InterpolationEnum interpolation=cmtk::Interpolators::LINEAR) const
	Interpolate sub-image with affine transformation.
void	SetROI (const Self::RegionType &roi)
	Set region of interest.
void	UnsetROI ()
	Clear region of interest.
virtual ScalarImage *	GetCropped () const
	Return cropped copy of this image.
void	CreatePixelData (const ScalarDataType dtype)
	Create pixel data array with given data type.
void	SetImageOrigin (const Self::SpaceVectorType &imageOrigin)
	Set image origin.
Self::SpaceVectorType	GetImageOrigin (const int frame=0) const
	Get image origin of given frame (default: 0).
	cmtkGetSetMacro (Self::SpaceVectorType, ImageDirectionX)
	Direction of image rows relative to ImageOrigin.
	cmtkGetSetMacro (Self::SpaceVectorType, ImageDirectionY)
	Direction of image columns relative to ImageOrigin.
	cmtkGetSetMacro (Types::Coordinate, ImageSlicePosition)
	Image position from coordinate origin along axial direction.
	cmtkGetSetMacro (Types::Coordinate, ImageTiltAngle)
	Image tilt with respect to axial position.
int	GetNumberOfPixels () const
	Get number of pixels.
Types::DataItem	GetPixelAt (const int i, const int j) const
	Get pixel at 2-D index.
bool	GetPixelAt (Types::DataItem &value, const Types::Coordinate i, const Types::Coordinate j) const
	Get pixel at fractional 2-D index by bilinear interpolation.
bool	GetPixelAtCubic (Types::DataItem &value, const Types::Coordinate i, const Types::Coordinate j) const
	Get pixel at fractional 2-D index by bicubic interpolation.
void	SetPixelAt (const int i, const int j, const Types::DataItem data)
	Set pixel at 2-D index.
virtual ScalarImage *	Clone () const
	Clone (duplicate) this object.
virtual ScalarImage *	Clone (const bool clonePixelData)
	Clone (duplicate) this object.
ScalarImage *	Downsample (const int factorX, int factorY=0, ScalarImage *const target=NULL) const
	Create downsampled copy of this image.
virtual void	ApplyBinaryMask (const ScalarImage *maskImage, const bool invert=false)
	Apply binary mask to image.
void	Mirror (const bool horizontal, const bool vertical)
	Mirror image horizontally and/or vertically.
void	AdjustAspect (const bool interpolate=false)
	Adjust aspect ratio.
void	AdjustToIsotropic (const Types::Coordinate pixelSize, const bool interpolate=false)
	Adjust aspect ratio.
void	ProjectPixel (const Self::SpaceVectorType &v, int &i, int &j) const
	Project 3D coordinate onto image plane.
ScalarImage &	operator-= (const ScalarImage &)
	Subtract one image from another in place.
virtual void	Print () const
	Print object information.
Image filter operators.
These functions perform various filter operations on the image data. For each filter, two functions are implemented: GetXXXFiltered and ApplyXXXFilter. The former returns a pointer to a newly allocated pixel data array that contains the filtered data. The latter replaces the current object's pixel data with the filtered data. Note: A complete new ScalarImage object with filtered pixel data can easily and efficiently be created by calling object->Clone( false )->ApplyXXXFilter().
TypedArray::SmartPtr	GetMedianFiltered (const byte range) const
	Return median-filtered image data.
ScalarImage *	ApplyMedianFilter (const byte range)
	Replace pixel data with median-filtered data.
TypedArray::SmartPtr	GetGaussFiltered (const Types::Coordinate stdDev) const
	Return Gauss-filtered (smoothed) image data.
ScalarImage *	ApplyGaussFilter (const Types::Coordinate stdDev)
	Replace pixel data with Gauss-filtered data.
TypedArray::SmartPtr	GetSobel2DFiltered () const
	Return Sobel-filtered (edge-enhanced) image data.
ScalarImage *	ApplySobel2DFilter ()
	Replace pixel data with Sobel-filtered data.
TypedArray::SmartPtr	GetLaplace2DFiltered () const
	Return Laplace-filtered (edge-enhanced) image data.
ScalarImage *	ApplyLaplace2DFilter ()
	Replace pixel data with Laplace-filtered data.
TypedArray::SmartPtr	GetSobelFiltered (const bool horizontal, const bool absolute=false) const
	Return Sobel-filtered (edge-enhanced) image data.
ScalarImage *	ApplySobelFilter (const bool horizontal, const bool absolute=false)
	Replace pixel data with 1-D Sobel-filtered data.
Public Attributes
Self::SpaceVectorType	m_ImageOrigin
	Origin of image in world coordinates.
Private Member Functions
	cmtkGetSetMacro (int, NumberOfFrames)
	Number of image frames for multi-frame images.
	cmtkGetSetMacro (TypedArray::SmartPtr, PixelData)
	Pixel data.
	cmtkGetSetMacro2Array (Types::Coordinate, PixelSize)
	Pixel spacing.
	cmtkGetSetMacro (Types::Coordinate, FrameToFrameSpacing)
	Frame-to-frame spacing.
TypedArray::SmartPtr	GetFilteredData (const std::vector< Types::DataItem > &filterX, const std::vector< Types::DataItem > &filterY) const
void	AdjustAspectY (const bool interpolate=false)
	Adjust aspect ratio by stretching in Y-direction.
void	AdjustAspectX (const bool interpolate=false)
	Adjust aspect ratio by stretching in X-direction.
Private Attributes
Self::IndexType	m_Dims
	Image dimensions.
Self::RegionType	ROI
	Cropping region of interest.
bool	HasROI
	Flag for validity of ROI.
Friends
ScalarImage *	operator- (const ScalarImage &, const ScalarImage &)
	Subtract one image from another.