Isis::Chip Class Reference
[Pattern Matching]

A small chip of data used for pattern matching. More...

#include <Chip.h>

Collaboration diagram for Isis::Chip:

Public Member Functions
	Chip ()
	Constructs a Chip.
	Chip (const Chip &other)
	Constructs a copy of the passed in chip.
	Chip (const int samples, const int lines)
	Construct a Chip with specified dimensions.
virtual	~Chip ()
	Destroys the Chip object.
void	SetSize (const int samples, const int lines)
	Change the size of the Chip.
bool	IsInsideChip (double sample, double line)
int	Samples () const
	Return the number of samples in the chip.
int	Lines () const
	Return the number of lines in the chip.
QString	FileName () const
	Returns the expanded filename of the cube from which this chip was chipped.
void	SetAllValues (const double &d)
	Single value assignment operator.
void	SetValue (int sample, int line, const double &value)
	This sets a value in the chip.
double	GetValue (int sample, int line)
	Loads a Chip with a value.
const double	GetValue (int sample, int line) const
	Get a value from a Chip.
void	TackCube (const double cubeSample, const double cubeLine)
	This sets which cube position will be located at the chip tack position.
int	TackSample () const
	Return the fixed tack sample of the chip.
int	TackLine () const
	Return the fixed tack line of the chip.
void	Load (Cube &cube, const double rotation=0.0, const double scale=1.0, const int band=1)
	Load cube data into the Chip.
void	Load (Cube &cube, Chip &match, Cube &matchChipCube, const double scale=1.0, const int band=1)
	Loads cube data into the Chip.
void	Load (Cube &cube, const Affine &affine, const bool &keepPoly=true, const int band=1)
	Load a chip using an Affine transform as provided by caller.
void	SetChipPosition (const double sample, const double line)
	Compute the position of the cube given a chip coordinate.
double	CubeSample () const
	Returns cube sample after invoking SetChipPosition.
double	CubeLine () const
	Returns cube line after invoking SetChipPosition.
void	SetCubePosition (const double sample, const double line)
	Compute the position of the chip given a cube coordinate.
double	ChipSample () const
	Returns chip sample after invoking SetCubePosition.
double	ChipLine () const
	Returns chip line after invoking SetCubePosition.
void	SetValidRange (const double minimum=Isis::ValidMinimum, const double maximum=Isis::ValidMaximum)
	Set the valid range of data in the chip.
bool	IsValid (double percentage)
	Return if the pixel is valid at a particular position.
bool	IsValid (int sample, int line)
	Returns whether the value at the given sample, line position is within the valid range.
Chip	Extract (int samples, int lines, int samp, int line)
	Extract a sub-chip from a chip.
void	Extract (int samp, int line, Chip &output)
	Extract a subchip centered at the designated coordinate.
Isis::Statistics *	Statistics ()
	Returns a statistics object of the current data in the chip.
void	Extract (Chip &output, Affine &affine)
	Extract a subchip of this chip using an Affine transform.
void	Write (const QString &filename)
	Writes the contents of the Chip to a cube.
void	SetClipPolygon (const geos::geom::MultiPolygon &clipPolygon)
	Sets the clipping polygon for this chip.
Chip &	operator= (const Chip &other)
	Copy assignment operator.
const Affine &	GetTransform () const
	Returns the Affine transformation of chip-to-cube indices.
void	SetTransform (const Affine &affine, const bool &keepPoly=true)
	Sets the internal Affine transform to new translation.
const Interpolator::interpType	GetReadInterpolator ()
	Access method that returns the Interpolator Type used for loading a chip.
void	SetReadInterpolator (const Interpolator::interpType type)
	Sets Interpolator Type for loading a chip.
Private Member Functions
void	Init (const int samples, const int lines)
	Common initialization used by constructors.
void	Read (Cube &cube, const int band)
	This method will read data from a cube and put it into the chip.
std::vector< int >	MovePoints (int startSamp, int startLine, int endSamp, int endLine)
	This method is called by Load() to move a control point across the chip.
bool	PointsColinear (double x0, double y0, double x1, double y1, double x2, double y2, double tol)
	This method is called by Load() to determine whether the given 3 points are nearly colinear.
Private Attributes
int	p_chipSamples
	Number of samples in the chip.
int	p_chipLines
	Number of lines in the chip.
std::vector< std::vector < double > >	p_buf
	Chip buffer.
int	p_tackSample
	Middle sample of the chip.
int	p_tackLine
	Middle line of the chip.
double	p_cubeTackSample
	cube sample at the chip tack
double	p_cubeTackLine
	cube line at the chip tack
double	p_validMinimum
	valid minimum chip pixel value
double	p_validMaximum
	valid maximum chip pixel value
double	p_chipSample
	chip sample set by SetChip/CubePosition
double	p_chipLine
	chip line set by SetChip/CubePosition
double	p_cubeSample
	cube sample set by SetCubePosition
double	p_cubeLine
	cube line set by SetCubePosition
geos::geom::MultiPolygon *	p_clipPolygon
	clipping polygon set by SetClipPolygon (line,samp)
Affine	p_affine
	Transform set by SetTransform. Used to load cubes into chip.
Interpolator::interpType	p_readInterpolator
	Interpolator type set by SetReadInterpolator. Used to read cubes into chip.
QString	p_filename
	FileName of loaded cube.

Detailed Description

A small chip of data used for pattern matching.

A chip is a small rectangular area that can be used for pattern matching. Data can be loaded into the chip manually or by reading directly from a cube.

Author:: 2005-05-05 Jeff Anderson

See also:: AutoReg; AutoRegFactory

For internal use only.

History:: 2006-07-11 Tracie Sucharski - Added reLoad method to use p_cube instead of cube passed in.

History:: 2006-08-03 Tracie Sucharski - Added Load and ReLoad method to apply scale factor to chip.

History:: 2006-08-04 Stuart Sides - Added SetClipPolygon method. If the clip polygon is set all pixel values outside the polygon will be set to NULL.

History:: 2007-10-01 Steven Koechle - Fixed inc in LoadChip to fix an infinite loop problem when x.size() never grew to be more than 3.

History:: 2009-01-19 Steven Koechle - Fixed memory leak

History:: 2009-06-02 Stacy Alley, Added a check in the SetSize() method to make sure the given samples and lines are not equal to or less than zero.

History:: 2009-08-19 Kris Becker - Added new Extract method that applies an Affine transform to the extract a portion of the chip; added an assigment operator that sets the entire chip to a single value for convenience; added a getter that returns a const reference to the internal Affine transform of this chip.

History:: 2009-08-20 Steven Lambright - Removed local cube pointer and parenthesis operator

History:: 2009-08-20 Travis Addair - Added Statistics method

History:: 2009-08-28 Kris Becker - Added new Affine setter method to establish a new Affine transform to the chip; added another Load method that uses a new Affine transform to load a chip from a cube.

History:: 2009-09-01 Travis Addair, Added valid Min/Max pixel value functionality for Statistics method

History:: 2010-01-28 Tracie Sucharski - In the Load method (with match chip) when calculating control points away from the corners, added a linc to move into the center of the chip in a non-linear fashion to prevent control points that fall in a line and cause the matrix inversion to fail.

History:: 2010-05-24 Jeannie Walldren - Fixed bug in the Load() method (with match chip). Modified to look for control points from each corner, rather than looping around. Added a method, PointsColinear() to check whether the points added are almost along the same line. Moved the code from Load() that chose new points to a new method, MovePoints().

History:: 2010-06-10 Jeannie Walldren - Modified PointsColinear() method to take in user defined tolerance as parameter to allow registration of more narrow search chip areas. Updated documentation, error messages and unitTest.

History:: 2010-06-15 Jeannie Walldren - Added set and accessor methods for Read() method's Interpolator::interpType. Updated documentation and unitTest.

History:: 2010-09-16 Jeannie Walldren - Updated unitTest, truth file and test cube to run properly with ShapeModel changes to Sensor class.

History:: 2011-03-29 Jai Rideout - Added copy constructor and equals operator.

History:: 2011-10-02 Kris Becker - Corrected a bug in the Extract(Chip, Affine) method when computing output pixels coordinates.

Definition at line 114 of file Chip.h.

Constructor & Destructor Documentation

Isis::Chip::Chip ( )

Constructs a Chip.

The default size is 3x3

Definition at line 47 of file Chip.cpp.

References Init().

Isis::Chip::Chip ( const Chip & other )

Constructs a copy of the passed in chip.

Parameters:

other

the chip to be copied

Definition at line 56 of file Chip.cpp.

References Isis::PolygonTools::MakeMultiPolygon(), p_affine, p_buf, p_chipLine, p_chipLines, p_chipSample, p_chipSamples, p_clipPolygon, p_cubeLine, p_cubeSample, p_cubeTackLine, p_cubeTackSample, p_filename, p_readInterpolator, p_tackLine, p_tackSample, p_validMaximum, and p_validMinimum.

Isis::Chip::Chip	(	const int	samples,
		const int	lines
	)

Construct a Chip with specified dimensions.

Parameters:

	samples	number of samples in the chip
	lines	number of lines in the chip

Definition at line 93 of file Chip.cpp.

References Init().

Isis::Chip::~Chip ( ) [virtual]

Destroys the Chip object.

Definition at line 99 of file Chip.cpp.

References p_clipPolygon.

Member Function Documentation

double Isis::Chip::ChipLine ( ) const [inline]

Returns chip line after invoking SetCubePosition.

Definition at line 231 of file Chip.h.

References p_chipLine.

Referenced by Isis::ChipViewport::cubeToViewport(), Isis::Gruen::getChipUpdate(), and Isis::AutoReg::SetSubpixelPosition().

double Isis::Chip::ChipSample ( ) const [inline]

Returns chip sample after invoking SetCubePosition.

Definition at line 226 of file Chip.h.

References p_chipSample.

Referenced by Isis::ChipViewport::cubeToViewport(), Isis::Gruen::getChipUpdate(), and Isis::AutoReg::SetSubpixelPosition().

double Isis::Chip::CubeLine ( ) const [inline]

Returns cube line after invoking SetChipPosition.

Definition at line 219 of file Chip.h.

References p_cubeLine.

Referenced by Isis::Gruen::getChipUpdate(), Isis::InterestOperator::InterestByMeasure(), Load(), Isis::ChipViewport::mousePressEvent(), Isis::InterestOperator::Operate(), Isis::ChipViewport::panDown(), Isis::ChipViewport::panLeft(), Isis::ChipViewport::panUp(), Read(), Isis::AutoReg::Register(), and Isis::ChipViewport::tackLine().

double Isis::Chip::CubeSample ( ) const [inline]

Returns cube sample after invoking SetChipPosition.

Definition at line 214 of file Chip.h.

References p_cubeSample.

Referenced by Isis::Gruen::getChipUpdate(), Isis::InterestOperator::InterestByMeasure(), Load(), Isis::ChipViewport::mousePressEvent(), Isis::InterestOperator::Operate(), Isis::ChipViewport::panDown(), Isis::ChipViewport::panLeft(), Isis::ChipViewport::panUp(), Read(), Isis::AutoReg::Register(), and Isis::ChipViewport::tackSample().

void Isis::Chip::Extract	(	Chip &	chipped,
		Affine &	affine
	)

Extract a subchip of this chip using an Affine transform.

This method will translate the data in this chip using an Affine transform to the output chip as provided. Note that the Affine transformation is only applied within the confines of this chip. No file I/O is performed.

A proper Affine transform should not deviate too much from the identity as the mapping operation may result in a NULL filled chip. The operation of this affine is added to the existing affine so that proper relationship to the input cube (and any affine operations applied at load time) is preserved. This implies that the resulting affine should yield nearly identical results when read directly from the cube.

Bilinear interpolation is applied to surrounding transformed pixels to provide each new output pixel.

The chipped parameter will be updated to fully reflect the state of this original chip. The state of the chipped parameter dictates the size and the tack sample and line coordinates. Upon return, the corresponding cube sample and line coordinate is updated to the tack sample and line chip coordinate.

As such, note that an identity affine transform will yield identical results to the Chip::Extract method specifying the tack sample and line as the location to extract.

The following example demonstrates how to linearly shift a chip one pixel right and one down.

   Chip mychip(35,35);
   Cube cube("mycube.cub");
   mychip.TackCube(200.0,200.0);
   mychip.Load(cube);

   Affine shift;
   shift.Translate(-1.0,-1.0);

   Chip ochip(15,15);
   mychip.Extract(ochip, shift);

Parameters:

	chipped	Input/output chip containing the transformed subchip
	affine	Affine transform to apply to extract subchip

Definition at line 897 of file Chip.cpp.

References cline, Isis::Affine::Compute(), csamp, Isis::Affine::Forward(), GetValue(), Isis::Interpolator::HotLine(), Isis::Interpolator::HotSample(), interp, Isis::Interpolator::Interpolate(), Lines(), Isis::Interpolator::Lines(), Isis::Null, p_affine, p_chipLine, p_chipSample, p_cubeLine, p_cubeSample, p_cubeTackLine, p_cubeTackSample, p_filename, p_validMaximum, p_validMinimum, Samples(), Isis::Interpolator::Samples(), SetValue(), TackLine(), TackSample(), Isis::Affine::xp(), and Isis::Affine::yp().

void Isis::Chip::Extract	(	int	samp,
		int	line,
		Chip &	chipped
	)

Extract a subchip centered at the designated coordinate.

This method extracts a subchip that is centered at the given sample and line coordinate. All appropriate variables in the given chipped parameter are set appropriately prior to return.

Parameters:

	samp	Center (tack) sample chip coordinate to extract subchip
	line	Center (tack) line chip coordinate to extract subchip
	chipped	Chip to load the subchip in and return to caller

Definition at line 821 of file Chip.cpp.

References GetValue(), Lines(), Isis::Null, p_affine, p_tackLine, p_tackSample, p_validMaximum, p_validMinimum, Samples(), SetValue(), TackLine(), and TackSample().

Chip Isis::Chip::Extract	(	int	samples,
		int	lines,
		int	samp,
		int	line
	)

Extract a sub-chip from a chip.

Parameters:

	samples	Number of samples in the extracted chip (must be less than or equal to "this" chip)
	lines	Number of lines in the extracted chip (must be less than or equal to "this" chip)
	samp	Input chip sample to be placed at output chip tack
	line	Input chip line to be placed at output chip tack

Returns:: Chip Sub-chip extracted from the chip

Exceptions:

Isis::IException::Programmer

- Chip extraction invalid

For internal use only.

History:: 2010-06-10 Jeannie Walldren - Modified error message

Definition at line 778 of file Chip.cpp.

References _FILEINFO_, GetValue(), Lines(), Isis::Null, p_affine, p_tackLine, p_tackSample, p_validMaximum, p_validMinimum, Isis::IException::Programmer, Samples(), SetValue(), TackLine(), and TackSample().

Referenced by Isis::AutoReg::ApplyGradientFilter(), Isis::InterestOperator::InterestByMeasure(), Isis::AutoReg::Match(), Isis::InterestOperator::Operate(), Isis::Gruen::Registration(), and Isis::AutoReg::Registration().

QString Isis::Chip::FileName ( ) const [inline]

Returns the expanded filename of the cube from which this chip was chipped.

Definition at line 137 of file Chip.h.

References p_filename.

const Interpolator::interpType Isis::Chip::GetReadInterpolator ( ) [inline]

Access method that returns the Interpolator Type used for loading a chip.

Returns:: const Interpolator::interpType Interpolator used to read data from cube and put it into a chip.

See also:: Read(); SetReadInterpolator()

Author:: Jeannie Walldren

For internal use only.

History:: 2010-06-05 Jeannie Walldren - Original version

Definition at line 309 of file Chip.h.

References p_readInterpolator.

const Affine& Isis::Chip::GetTransform ( ) const [inline]

Returns the Affine transformation of chip-to-cube indices.

This method returns the affine transform used to load a chip from the same area as a match cube. It also is used to track the tack point line and sample translations from the chip indices to the absolute cube coordiates.

Returns:: const Affine& Transform map from chip coordinates to cube coordinates

Definition at line 273 of file Chip.h.

References p_affine.

const double Isis::Chip::GetValue	(	int	sample,
		int	line
	)			const `[inline]`

Get a value from a Chip.

For example,

 Chip c(10,5);
 cout << c[3,3] << endl;

Parameters:

	sample	Sample position to get (1-based)
	line	Line position to get (1-based)

Definition at line 178 of file Chip.h.

References p_buf.

double Isis::Chip::GetValue	(	int	sample,
		int	line
	)			`[inline]`

Loads a Chip with a value.

For example,

 Chip c(10,5);
 c(1,1) = 1.1;
 c(10,5) = 1.2;

Parameters:

	sample	Sample position to load (1-based)
	line	Line position to load (1-based)

Definition at line 165 of file Chip.h.

References p_buf.

Referenced by Isis::Gruen::algorithm(), Isis::AutoReg::ApplyGradientFilter(), Isis::AutoReg::ComputeChipZScore(), Isis::ChipViewport::computeStretch(), Isis::CentroidApolloPan::elipticalReduction(), Extract(), Isis::StandardDeviationOperator::Interest(), Isis::MoravecOperator::Interest(), Isis::GradientOperator::Interest(), Isis::ForstnerOperator::Interest(), IsValid(), Isis::MinimumDifference::MatchAlgorithm(), Isis::MaximumCorrelation::MatchAlgorithm(), Isis::ChipViewport::paintImage(), Isis::AutoReg::Reduce(), Isis::AutoReg::SetSubpixelPosition(), and Write().

void Isis::Chip::Init	(	const int	samples,
		const int	lines
	)			`[private]`

Common initialization used by constructors.

Parameters:

	samples	number of samples in the chip
	lines	number of lines in the chip

For internal use only.

History:: 2010-06-15 Jeannie Walldren - Added call to set Read() method's interpolator to default to Cubic Convolution type

Definition at line 126 of file Chip.cpp.

References p_clipPolygon, SetReadInterpolator(), SetSize(), and SetValidRange().

Referenced by Chip().

bool Isis::Chip::IsInsideChip	(	double	sample,
		double	line
	)

Parameters:

	sample
	line

Returns:: bool True if the given sample, line is inside the chip

Definition at line 169 of file Chip.cpp.

References maxLine, minLine, p_chipLines, p_chipSamples, p_cubeTackLine, and p_cubeTackSample.

Referenced by Isis::ChipViewport::cubeToViewport().

bool Isis::Chip::IsValid	(	int	sample,
		int	line
	)			`[inline]`

Returns whether the value at the given sample, line position is within the valid range.

Parameters:

	sample	Sample position
	line	Line position

Definition at line 245 of file Chip.h.

References GetValue(), p_validMaximum, and p_validMinimum.

bool Isis::Chip::IsValid ( double percentage )

Return if the pixel is valid at a particular position.

Parameters:

	sample	sample position to test
	line	line position to test

Returns:: bool - Returns true if the pixel is valid, and false if it is not Return if the total number of valid pixels in the chip meets a specified percentage of the entire chip.

Parameters:

percentage

The percentage that the valid pixels percentage must exceed

Returns:: bool Returns true if the percentage of valid pixels is greater than the specified percentage, and false if it is not

Definition at line 749 of file Chip.cpp.

References line, Lines(), Samples(), and validCount.

Referenced by Isis::Gruen::algorithm(), Isis::AutoReg::Register(), and Isis::AutoReg::Registration().

int Isis::Chip::Lines ( ) const [inline]

Return the number of lines in the chip.

Definition at line 131 of file Chip.h.

References p_chipLines.

Referenced by Isis::Gruen::algorithm(), Isis::AutoReg::ApplyGradientFilter(), Isis::ChipViewport::chipLines(), Isis::AutoReg::ComputeChipZScore(), Isis::ChipViewport::computeStretch(), Isis::CentroidApolloPan::elipticalReduction(), Extract(), Isis::AutoReg::Init(), Isis::StandardDeviationOperator::Interest(), Isis::MoravecOperator::Interest(), Isis::GradientOperator::Interest(), Isis::ForstnerOperator::Interest(), IsValid(), Load(), Isis::AutoReg::Match(), Isis::MinimumDifference::MatchAlgorithm(), Isis::MaximumCorrelation::MatchAlgorithm(), Isis::ChipViewport::paintImage(), Read(), Isis::AutoReg::Reduce(), Isis::AutoReg::Register(), Isis::Gruen::Registration(), Isis::ChipViewport::setChip(), Isis::AutoReg::SetSubpixelPosition(), Isis::AutoReg::UpdatedTemplate(), and Write().

void Isis::Chip::Load	(	Cube &	cube,
		const Affine &	affine,
		const bool &	keepPoly = `true`,
		const int	band = `1`
	)

Load a chip using an Affine transform as provided by caller.

This method will load data from a cube using an established Affine transform as provided by the caller. It is up to the caller to set up the affine appropriately.

For example, the first thing this method will do is set the chip tack point to the transformed cube location by replacing the existing affine transform with the one passed in and then calling SetChipPosition providing the chip tack point as the argument. This establishes which cube pixel is located at the chip tack point.

The data will be loaded to sub-pixel accuracy using the interpolator indicated using SetReadInterpolator() method.

Parameters:

	cube	Cube to load the data from
	affine	Affine transform to set for chip load/operations
	keepPoly	Indicates whether clipping polygon should be kept or removed (default of true)
	band	Band number to read data from (default of 1)

See also:: Read(); SetReadInterpolator(); GetReadInterpolator()

Definition at line 257 of file Chip.cpp.

References Isis::Cube::fileName(), p_clipPolygon, p_filename, Read(), SetChipPosition(), SetTransform(), TackLine(), and TackSample().

void Isis::Chip::Load	(	Cube &	cube,
		Chip &	match,
		Cube &	matchChipCube,
		const double	scale = `1.0`,
		const int	band = `1`
	)

Loads cube data into the Chip.

The data will be loaded such that the position set using TackCube method will be put at the center of the chip. The data will be loaded to sub-pixel accuracy using the interpolator indicated using SetReadInterpolator() method. Additionally, the data will be loaded such that it matches the camera and/or projective geometry of a given Chip.

Parameters:

	cube	The cube used to put data into the chip
	match	Match the geometry of this chip
	matchChipCube	The cube used to put data into the match chip
	scale	scale factor (default of 1)
	band	Band number to use when loading (default of 1)

Exceptions:

	Isis::iException::Programmer	- Chip cube is not a camera or map projection
	Isis::iException::Programmer	- Match chip cube is not a camera or map projection
	Isis::iException::Programmer	- Cannot find enough points to perform Affine transformation.

See also:: Read(); SetReadInterpolator(); GetReadInterpolator()

For internal use only.

History:: 2010-01-28 Tracie Sucharski - When calculating control points away from the corners, added a linc to move into the center of the chip in a non-linear fashion to prevent control points that fall in a line and cause the matrix inversion to fail.

History:: 2010-05-24 Jeannie Walldren - Modified code when looking for control points for affine to start at each corner and move inward rather than looping around the corners. This lessens the likelyhood that the points will be too linear for the transform to work properly. A check was also added to ensure that we do not choose colinear points.

History:: 2010-06-10 Jeannie Walldren - Modified error message and added tolerance to linearity check. Fixed error messages.

Definition at line 319 of file Chip.cpp.

References _FILEINFO_, Isis::IException::append(), cam, Isis::Cube::camera(), Isis::Affine::Compute(), CubeLine(), CubeSample(), Isis::Cube::fileName(), Isis::Sensor::HasSurfaceIntersection(), Isis::Projection::IsGood(), Isis::Camera::Line(), line, Lines(), MovePoints(), p_affine, p_cubeTackLine, p_cubeTackSample, p_filename, PointsColinear(), proj, Isis::Cube::projection(), Read(), Isis::Camera::Sample(), Samples(), Isis::Affine::Scale(), SetChipPosition(), Isis::Camera::SetImage(), Isis::Projection::SetUniversalGround(), Isis::Camera::SetUniversalGround(), Isis::Projection::SetWorld(), Isis::Affine::Solve(), TackLine(), TackSample(), Isis::Affine::Translate(), Isis::Projection::UniversalLatitude(), Isis::Sensor::UniversalLatitude(), Isis::Projection::UniversalLongitude(), Isis::Sensor::UniversalLongitude(), Isis::IException::User, Isis::Projection::WorldX(), Isis::Projection::WorldY(), x, Isis::Affine::xp(), y, and Isis::Affine::yp().

void Isis::Chip::Load	(	Cube &	cube,
		const double	rotation = `0.0`,
		const double	scale = `1.0`,
		const int	band = `1`
	)

Load cube data into the Chip.

The data will be loaded such that the position set using TackCube method will be put at the center of the chip. The data will be loaded to sub-pixel accuracy using the interpolator indicated using SetReadInterpolator() method.

Parameters:

	cube	The cube used to put data into the chip
	rotation	rotation in degrees of data about the cube tack point (default of 0)
	scale	scale factor (default of 1)
	band	Band number to use when loading (default of 1)

See also:: Read(); SetReadInterpolator(); GetReadInterpolator()

Definition at line 212 of file Chip.cpp.

References Isis::Cube::fileName(), Isis::Affine::Identity(), p_affine, p_cubeTackLine, p_cubeTackSample, p_filename, Read(), Isis::Affine::Rotate(), Isis::Affine::Scale(), and Isis::Affine::Translate().

Referenced by Isis::ChipViewport::geomChip(), Isis::InterestOperator::InterestByMeasure(), Isis::ChipViewport::nogeomChip(), Isis::InterestOperator::Operate(), Isis::ControlPointEdit::registerPoint(), Isis::ChipViewport::reloadChip(), Isis::ChipViewport::rotateChip(), Isis::ControlPointEdit::setLeftMeasure(), and Isis::ControlPointEdit::setRightMeasure().

vector< int > Isis::Chip::MovePoints	(	int	startSamp,
		int	startLine,
		int	endSamp,
		int	endLine
	)			`[private]`

This method is called by Load() to move a control point across the chip.

Parameters:

	*startSamp	Sample value to be increased, or moved right.
	*startLine	Line value to be increased, or moved downward.
	*endSamp	Sample value to be decreased, or moved left.
	*endLine	Line value to be decreased, or moved upward.

Returns:: vector < int > Vector containing the new sample and line values in the same order as the parameters passed into the method.

For internal use only.

Author:: Tracie Sucharski

History:: 2010-05-24 Jeannie Walldren - Moved from Load() method to its own method since this code needed to be repeated several times.

Definition at line 643 of file Chip.cpp.

References linc, and sinc.

Referenced by Load().

Chip & Isis::Chip::operator= ( const Chip & other )

Copy assignment operator.

Parameters:

other

chip to be copied to this

Definition at line 1070 of file Chip.cpp.

References Isis::PolygonTools::MakeMultiPolygon(), p_affine, p_buf, p_chipLine, p_chipLines, p_chipSample, p_chipSamples, p_clipPolygon, p_cubeLine, p_cubeSample, p_cubeTackLine, p_cubeTackSample, p_filename, p_readInterpolator, p_tackLine, p_tackSample, p_validMaximum, and p_validMinimum.

bool Isis::Chip::PointsColinear	(	double	x0,
		double	y0,
		double	x1,
		double	y1,
		double	x2,
		double	y2,
		double	tol
	)			`[private]`

This method is called by Load() to determine whether the given 3 points are nearly colinear.

This is done by considering the triangle composed of these points. The method returns true if all angles of the triangle are greater than the tolerance angle and less than 180 degrees minus the tolerance angle.

Parameters:

	x0	The x-value of the first point
	y0	The y-value of the first point
	x1	The x-value of the second point
	y1	The y-value of the second point
	x2	The x-value of the third point
	y2	The y-value of the third point
	tol	Minimum tolerance angle in degrees

Returns:: bool True if 3 given points are nearly colinear

For internal use only.

Author:: Jeannie Walldren

History:: 2010-05-24 Jeannie Walldren - Original version.

History:: 2010-06-10 Jeannie Walldren - Modified to take in user defined tolerance as parameter to allow registration of narrow search chip areas

Definition at line 571 of file Chip.cpp.

References min(), and Isis::PI().

Referenced by Load().

void Isis::Chip::Read	(	Cube &	cube,
		const int	band
	)			`[private]`

This method will read data from a cube and put it into the chip.

The affine transform is used in the SetChipPosition routine and therefore the geom of the chip is automatic. This method uses a default interpolator type of Cubic Convolution. This can be changed using the SetReadInterpolator() method,

Parameters:

	cube	Cube to read data from
	band	Band number to read data from

See also:: SetReadInterpolator

Todo:: We could modify the affine class to return the coefficients and then compute the derivative of the change in cube sample and line with respect to chip sample or line. The change might make the geom run a bit faster.

See also:: SetReadInterpolator(); GetReadInterpolator()

For internal use only.

History:: 2010-06-15 Jeannie Walldren - Modified to allow use of any interpolator type except "None"

Definition at line 992 of file Chip.cpp.

References CubeLine(), CubeSample(), Isis::Interpolator::HotLine(), Isis::Interpolator::HotSample(), interp, Isis::Interpolator::Interpolate(), line, Isis::Cube::lineCount(), Lines(), Isis::Interpolator::Lines(), p_buf, p_clipPolygon, p_readInterpolator, Isis::Cube::pixelType(), Isis::Cube::read(), Isis::Cube::sampleCount(), Samples(), Isis::Interpolator::Samples(), and SetChipPosition().

Referenced by Load().

int Isis::Chip::Samples ( ) const [inline]

Return the number of samples in the chip.

Definition at line 126 of file Chip.h.

References p_chipSamples.

Referenced by Isis::Gruen::algorithm(), Isis::AutoReg::ApplyGradientFilter(), Isis::ChipViewport::chipSamples(), Isis::AutoReg::ComputeChipZScore(), Isis::ChipViewport::computeStretch(), Isis::CentroidApolloPan::elipticalReduction(), Extract(), Isis::AutoReg::Init(), Isis::StandardDeviationOperator::Interest(), Isis::MoravecOperator::Interest(), Isis::GradientOperator::Interest(), Isis::ForstnerOperator::Interest(), IsValid(), Load(), Isis::AutoReg::Match(), Isis::MinimumDifference::MatchAlgorithm(), Isis::MaximumCorrelation::MatchAlgorithm(), Isis::ChipViewport::paintImage(), Read(), Isis::AutoReg::Reduce(), Isis::AutoReg::Register(), Isis::Gruen::Registration(), Isis::ChipViewport::setChip(), Isis::AutoReg::SetSubpixelPosition(), Isis::AutoReg::UpdatedTemplate(), and Write().

void Isis::Chip::SetAllValues ( const double & d )

Single value assignment operator.

Sets the entire chip to a constant

Parameters:

d

Value to set the chip to

Definition at line 111 of file Chip.cpp.

References fill(), and p_buf.

void Isis::Chip::SetChipPosition	(	const double	sample,
		const double	line
	)

Compute the position of the cube given a chip coordinate.

Any rotation or geometric matching done during the Load process will be taken into account. Use the CubeSample and CubeLine methods to obtain results. Note the results could be outside of the cube

Parameters:

	sample	chip sample coordinate
	line	chip line coordinate

Definition at line 671 of file Chip.cpp.

References Isis::Affine::Compute(), p_affine, p_chipLine, p_chipSample, p_cubeLine, p_cubeSample, TackLine(), TackSample(), Isis::Affine::xp(), and Isis::Affine::yp().

Referenced by Isis::Gruen::getChipUpdate(), Isis::InterestOperator::InterestByMeasure(), Load(), Isis::ChipViewport::mousePressEvent(), Isis::InterestOperator::Operate(), Isis::ChipViewport::panDown(), Isis::ChipViewport::panLeft(), Isis::ChipViewport::panUp(), Read(), Isis::AutoReg::Register(), Isis::Gruen::Registration(), Isis::AutoReg::Registration(), Isis::ChipViewport::tackLine(), and Isis::ChipViewport::tackSample().

void Isis::Chip::SetClipPolygon ( const geos::geom::MultiPolygon & clipPolygon )

Sets the clipping polygon for this chip.

The coordinates must be in (sample,line) order. All Pixel values outside this polygon will be set to Null8. The cubic convolution interpolation is allowed to uses valid pixels outside the clipping area.

Parameters:

clipPolygon

The polygons used to clip the chip

Definition at line 1060 of file Chip.cpp.

References Isis::PolygonTools::CopyMultiPolygon(), and p_clipPolygon.

Referenced by Isis::InterestOperator::InterestByMeasure(), and Isis::InterestOperator::Operate().

void Isis::Chip::SetCubePosition	(	const double	sample,
		const double	line
	)

Compute the position of the chip given a cube coordinate.

Any rotation or geometric matching done during the Load process will be taken into account. Use the ChipSample and ChipLine methods to obtain results. Note that the results could be outside of the chip.

Parameters:

	sample	chip sample coordinate
	line	chip line coordinate

Definition at line 690 of file Chip.cpp.

References Isis::Affine::ComputeInverse(), p_affine, p_chipLine, p_chipSample, p_cubeLine, p_cubeSample, TackLine(), TackSample(), Isis::Affine::x(), and Isis::Affine::y().

Referenced by Isis::ChipViewport::cubeToViewport().

void Isis::Chip::SetReadInterpolator ( const Interpolator::interpType type ) [inline]

Sets Interpolator Type for loading a chip.

This type is used in the Read() method.

Parameters:

type

Interpolator type to be used.

Exceptions:

IException::Programmer

- Invalid Interpolator Type

See also:: Read(); SetReadInterpolator()

Author:: Jeannie Walldren

For internal use only.

History:: 2010-06-05 Jeannie Walldren - Original version

Definition at line 325 of file Chip.h.

References _FILEINFO_, p_readInterpolator, Isis::IException::Programmer, and Isis::toString().

Referenced by Init(), and Isis::AutoReg::SetChipInterpolator().

void Isis::Chip::SetSize	(	const int	samples,
		const int	lines
	)

Change the size of the Chip.

Parameters:

	samples	number of samples in the chip
	lines	number of lines in the chip

Exceptions:

Isis::iException::User

- Samples and lines must be greater than zero.

For internal use only.

History:: 2010-06-10 Jeannie Walldren - Modified error message

Definition at line 144 of file Chip.cpp.

References _FILEINFO_, Isis::Affine::Identity(), p_affine, p_buf, p_chipLines, p_chipSamples, p_tackLine, p_tackSample, and Isis::IException::User.

Referenced by Isis::AutoReg::AutoReg(), Init(), Isis::AutoReg::Match(), Isis::AutoReg::Parse(), Isis::AutoReg::Register(), and Isis::Gruen::Registration().

void Isis::Chip::SetTransform	(	const Affine &	affine,
		const bool &	keepPoly = `true`
	)			`[inline]`

Sets the internal Affine transform to new translation.

Provides the ability to establish a new affine transformation without overhead of, say, loading the chip with a new translation.

The caller also has the option to specify the disposition of an established polygon.

Parameters:

	affine	New affine tranform to set for this chip
	keepPoly	Indicates whether an existing polygon clipper should be kept (default of true)

Definition at line 290 of file Chip.h.

References p_affine, and p_clipPolygon.

Referenced by Load().

void Isis::Chip::SetValidRange	(	const double	minimum = `Isis::ValidMinimum`,
		const double	maximum = `Isis::ValidMaximum`
	)

Set the valid range of data in the chip.

If never called all data in the chip is consider valid (other than special pixels).

Parameters:

	minimum	minimum valid pixel value (default of Isis::ValidMinimum)
	maximum	maximum valid pixel value (default of Isis::ValidMaximum)

Exceptions:

Isis::iException::Programmer

- First parameter must be smaller than the second.

For internal use only.

History:: 2010-06-10 Jeannie Walldren - Modified error message

Definition at line 711 of file Chip.cpp.

References _FILEINFO_, p_validMaximum, p_validMinimum, and Isis::IException::Programmer.

Referenced by Init(), and Isis::AutoReg::Parse().

void Isis::Chip::SetValue	(	int	sample,
		int	line,
		const double &	value
	)			`[inline]`

This sets a value in the chip.

Parameters:

	sample	Sample position to load (1-based)
	line	Line position to load (1-based)
	value	Value to set

Definition at line 150 of file Chip.h.

References p_buf.

Referenced by Isis::AutoReg::ApplyGradientFilter(), Isis::CentroidApolloPan::elipticalReduction(), Extract(), Isis::AutoReg::Init(), Isis::AutoReg::Match(), Isis::AutoReg::Reduce(), Isis::AutoReg::Register(), and Isis::AutoReg::SetSubpixelPosition().

Isis::Statistics * Isis::Chip::Statistics ( )

Returns a statistics object of the current data in the chip.

The caller takes ownership of the returned instance.

Returns:: Isis::Statistics* Statistics of the data in the chip

Definition at line 958 of file Chip.cpp.

References Isis::Statistics::AddData(), p_buf, p_chipLines, p_chipSamples, p_validMaximum, p_validMinimum, and stats.

void Isis::Chip::TackCube	(	const double	cubeSample,
		const double	cubeLine
	)

This sets which cube position will be located at the chip tack position.

Parameters:

	cubeSample	the cube sample value to tack
	cubeLine	the cube line value to tack

Definition at line 189 of file Chip.cpp.

References Isis::Affine::Identity(), p_affine, p_cubeTackLine, p_cubeTackSample, and Isis::Affine::Translate().

Referenced by Isis::Gruen::getChipUpdate(), Isis::InterestOperator::InterestByMeasure(), Isis::InterestOperator::Operate(), Isis::ControlPointEdit::registerPoint(), Isis::ChipViewport::reloadChip(), Isis::ControlPointEdit::setLeftMeasure(), and Isis::ControlPointEdit::setRightMeasure().

int Isis::Chip::TackLine ( ) const [inline]

Return the fixed tack line of the chip.

That is, the middle of the chip. It is a chip coordinate not a cube coordinate. For a chip with 5 lines, this will return 3, the middle pixel. For a chip with 4 lines it will return 2

Definition at line 200 of file Chip.h.

References p_tackLine.

Referenced by Isis::Gruen::algorithm(), Extract(), Isis::Gruen::getChipUpdate(), Load(), Isis::ChipViewport::panDown(), Isis::ChipViewport::panLeft(), Isis::ChipViewport::panUp(), Isis::AutoReg::Register(), Isis::Gruen::Registration(), SetChipPosition(), SetCubePosition(), Isis::ChipViewport::tackLine(), and Isis::ChipViewport::tackSample().

int Isis::Chip::TackSample ( ) const [inline]

Return the fixed tack sample of the chip.

That is, the middle of the chip. It is a chip coordinate not a cube coordinate. For a chip with 5 samples, this will return 3, the middle pixel. For a chip with 4 samples it will return 2

Definition at line 190 of file Chip.h.

References p_tackSample.

Referenced by Isis::Gruen::algorithm(), Extract(), Isis::Gruen::getChipUpdate(), Load(), Isis::ChipViewport::panDown(), Isis::ChipViewport::panLeft(), Isis::ChipViewport::panUp(), Isis::AutoReg::Register(), Isis::Gruen::Registration(), SetChipPosition(), SetCubePosition(), Isis::ChipViewport::tackLine(), and Isis::ChipViewport::tackSample().