This class is used to rewrite the "alpha" keywords out of the AlphaCube group or Instrument group. More...

#include <AlphaCube.h>

Collaboration diagram for Isis::AlphaCube:

Public Member Functions
	AlphaCube (Cube &cube)
	Constructs an AlphaCube object using a PVL object. More...

	AlphaCube (int alphaSamples, int alphaLines, int betaSamples, int betaLines)
	Constructs an AlphaCube object given alphaSamples, alphaLines, betaSamples and betaLines. More...

	AlphaCube (int alphaSamples, int alphaLines, int betaSamples, int betaLines, double alphaSs, double alphaSl, double alphaEs, double alphaEl)
	Constructs an AlphaCube object with a basic mapping from corner-to-corner, beta 0.5,0.5 maps to alpha 0.5,0.5 and beta ns+0.5,nl+0.5 maps to alpha ns+0.5, nl+0.5. More...

	~AlphaCube ()
	Destroys the AlphaCube object. More...

int	AlphaLines () const
	Returns the number of lines in the alpha cube. More...

int	AlphaSamples () const
	Returns the number of samples in the alpha cube. More...

int	BetaLines () const
	Returns the number of lines in the beta cube. More...

int	BetaSamples () const
	Returns the number of samples in the beta cube. More...

double	AlphaLine (double betaLine)
	Returns an alpha line given a beta line. More...

double	AlphaSample (double betaSample)
	Returns an alpha sample given a beta sample. More...

double	BetaLine (double alphaLine)
	Returns a beta line given an alpha line. More...

double	BetaSample (double alphaSample)
	Returns a beta sample given an alpha sample. More...

void	UpdateGroup (Cube &cube)
	Writes or update the Alpha keywords (AlphaLines, AlphaSamples, AlphaStartingSamples, etc) in the proper group in a PVL object. More...

void	Rehash (AlphaCube &alphaCube)
	Merges two AlphaCube objects. More...

Detailed Description

This class is used to rewrite the "alpha" keywords out of the AlphaCube group or Instrument group.

This class allows programmers to map cube pixel positions back to the first cube they came from.This is critical for camera models or radiometric models in order to map input cube pixels to camera detector position. The alpha keywords are automatically generated in programs like crop, pad, reduce, and enlarge.

Author: 2004-02-13 Jeff Anderson

Constructor & Destructor Documentation

◆ AlphaCube() [1/3]

Isis::AlphaCube::AlphaCube ( Cube & cube )

Constructs an AlphaCube object using a PVL object.

Parameters

cube	The cube to write to

References Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::Cube::label(), Isis::Cube::lineCount(), and Isis::Cube::sampleCount().

◆ AlphaCube() [2/3]

Isis::AlphaCube::AlphaCube	(	int	alphaSamples,
		int	alphaLines,
		int	betaSamples,
		int	betaLines
	)

Constructs an AlphaCube object given alphaSamples, alphaLines, betaSamples and betaLines.

Parameters

alphaSamples	Number of alpha samples in the cube
alphaLines	Number of alpha lines in the cube
betaSamples	Number of beta samples in the cube
betaLines	Number of beta lines in the cube

◆ AlphaCube() [3/3]

Isis::AlphaCube::AlphaCube	(	int	alphaSamples,
		int	alphaLines,
		int	betaSamples,
		int	betaLines,
		double	alphaSs,
		double	alphaSl,
		double	alphaEs,
		double	alphaEl
	)

Constructs an AlphaCube object with a basic mapping from corner-to-corner, beta 0.5,0.5 maps to alpha 0.5,0.5 and beta ns+0.5,nl+0.5 maps to alpha ns+0.5, nl+0.5.

Parameters

alphaSamples	Number of alpha samples in the cube
alphaLines	Number of alpha lines in the cube
betaSamples	Number of beta samples in the cube
betaLines	Number of beta lines in the cube
alphaSs	Starting alpha sample
alphaSl	Starting alpha line
alphaEs	Ending alpha sample
alphaEl	Ending alpha line

◆ ~AlphaCube()

Isis::AlphaCube::~AlphaCube ( )

inline

Destroys the AlphaCube object.

Member Function Documentation

◆ AlphaLine()

double Isis::AlphaCube::AlphaLine ( double betaLine )

inline

Returns an alpha line given a beta line.

Parameters

betaLine The beta line

Returns: double Beta line

Referenced by Rehash(), and Isis::Camera::SetImage().

◆ AlphaLines()

int Isis::AlphaCube::AlphaLines ( ) const

inline

Returns the number of lines in the alpha cube.

Returns: int Number of lines in the alpha cube

Referenced by Isis::Camera::ParentLines().

◆ AlphaSample()

double Isis::AlphaCube::AlphaSample ( double betaSample )

inline

Returns an alpha sample given a beta sample.

Parameters

betaSample The beta sample

Returns: double Beta sample

Referenced by Rehash(), and Isis::Camera::SetImage().

◆ AlphaSamples()

int Isis::AlphaCube::AlphaSamples ( ) const

inline

Returns the number of samples in the alpha cube.

Returns: int Number of samples in the alpha cube

Referenced by Isis::Camera::ParentSamples().

◆ BetaLine()

double Isis::AlphaCube::BetaLine ( double alphaLine )

inline

Returns a beta line given an alpha line.

Parameters

alphaLine The alpha line

Returns: double Alpha line

Referenced by Isis::Camera::SetRightAscensionDeclination().

◆ BetaLines()

int Isis::AlphaCube::BetaLines ( ) const

inline

Returns the number of lines in the beta cube.

Returns: int Number of lines in the beta cube

Referenced by Isis::Camera::CacheSize(), Isis::Camera::LoadCache(), Rehash(), and Isis::Camera::StartEndEphemerisTimes().

◆ BetaSample()

double Isis::AlphaCube::BetaSample ( double alphaSample )

inline

Returns a beta sample given an alpha sample.

Parameters

alphaSample The alpha sample

Returns: double Alpha sample

Referenced by Isis::Camera::SetRightAscensionDeclination().

◆ BetaSamples()

int Isis::AlphaCube::BetaSamples ( ) const

inline

Returns the number of samples in the beta cube.

Returns: int Number of samples in the beta cube

Referenced by Isis::Camera::LoadCache(), Rehash(), and Isis::Camera::StartEndEphemerisTimes().

◆ Rehash()

void Isis::AlphaCube::Rehash ( AlphaCube & add )

Merges two AlphaCube objects.

This facilities combinations of programs crop-enlarge, crop-crop, reduce-pad, etc.

Parameters

add	The AlphaCube object to be merged.

References AlphaLine(), AlphaSample(), BetaLines(), and BetaSamples().

Referenced by UpdateGroup().

◆ UpdateGroup()

void Isis::AlphaCube::UpdateGroup ( Isis::Cube & cube )

Writes or update the Alpha keywords (AlphaLines, AlphaSamples, AlphaStartingSamples, etc) in the proper group in a PVL object.

It chooses first to write and AlphaGroup if the Mapping group exists. If not then is will write the keywords in the Instrument group if it exists. Otherwise it will write to the AlphaCube group.

Parameters

&cube The cube to write to.

References Isis::PvlObject::addGroup(), Isis::PvlObject::findGroup(), Isis::PvlObject::findObject(), Isis::PvlObject::hasGroup(), Isis::Cube::label(), Rehash(), and Isis::toString().

Referenced by Isis::SubArea::UpdateLabel().

The documentation for this class was generated from the following files:

/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/AlphaCube/AlphaCube.h
/usgs/pkgs/isis3.9.0_docs/ISIS3/isis/src/base/objs/AlphaCube/AlphaCube.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ AlphaCube() [1/3]

◆ AlphaCube() [2/3]

◆ AlphaCube() [3/3]

◆ ~AlphaCube()

Member Function Documentation

◆ AlphaLine()

◆ AlphaLines()

◆ AlphaSample()

◆ AlphaSamples()

◆ BetaLine()

◆ BetaLines()

◆ BetaSample()

◆ BetaSamples()

◆ Rehash()

◆ UpdateGroup()