Isis::CameraStatistics Class Reference
[Spice, Instruments, and Cameras]

Calculates a series of statistics pertaining to a Camera. More...

#include <CameraStatistics.h>

Collaboration diagram for Isis::CameraStatistics:

Public Member Functions
	CameraStatistics (QString filename, int sinc, int linc)
	Constructs the Camera Statistics object from a Cube filename.
	CameraStatistics (Camera *cam, int sinc, int linc)
	Constructs the Camera Statistics object from an already-existent Camera pointer.
	CameraStatistics (Camera *cam, int sinc, int linc, QString filename)
	Constructs the Camera Statistics object from an already-existent Camera pointer.
virtual	~CameraStatistics ()
	Destroy this instance, deletes all the Statistics objects.
void	addStats (Camera *cam, int &sample, int &line)
	Add statistics data to Statistics objects if the Camera position given by the provided line and sample is looking at the surface of the target.
PvlKeyword	constructKeyword (QString keyname, double value, QString unit) const
	Takes a name, value, and optionally units and constructs a PVL Keyword.
Pvl	toPvl () const
	Constructs a Pvl object from the values in the various statistics objects.
const Statistics *	getLatStat () const
	Accessor method for inspecting the statistics gathered on the Universal Latitudes of the input Camera.
const Statistics *	getLonStat () const
	Accessor method for inspecting the statistics gathered on the Universal Longitudes of the input Camera.
const Statistics *	getResStat () const
	Accessor method for inspecting the statistics gathered on the Pixel Resolutions of the input Camera.
const Statistics *	getSampleResStat () const
	Accessor method for inspecting the statistics gathered on the Sample Resolutions of the input Camera.
const Statistics *	getLineResStat () const
	Accessor method for inspecting the statistics gathered on the Line Resolution of the input Camera.
const Statistics *	getAspectRatioStat () const
	Accessor method for inspecting the statistics gathered on the Aspect Ratios of the input Camera.
const Statistics *	getPhaseStat () const
	Accessor method for inspecting the statistics gathered on the Phase Angles of the input Camera.
const Statistics *	getEmissionStat () const
	Accessor method for inspecting the statistics gathered on the Emission Angles of the input Camera.
const Statistics *	getIncidenceStat () const
	Accessor method for inspecting the statistics gathered on the Incidence Angles of the input Camera.
const Statistics *	getLocalSolarTimeStat () const
	Accessor method for inspecting the statistics gathered on the Local Solar Times of the input Camera.
const Statistics *	getLocalRaduisStat () const
	Accessor method for inspecting the statistics gathered on the Local Radii (in meters) of the input Camera.
const Statistics *	getNorthAzimuthStat () const
	Accessor method for inspecting the statistics gathered on the North Azimuths of the input Camera.
Private Member Functions
void	init (Camera *cam, int sinc, int linc, QString filename)
	FileName of the Cube the Camera was derived from.
Private Attributes
QString	m_filename
int	m_sinc
	Sample increment for composing statistics.
int	m_linc
	Line increment for composing statistics.
Statistics *	m_latStat
	Universal latitude statistics.
Statistics *	m_lonStat
	Universal longitude statistics.
Statistics *	m_resStat
	Pixel resolution statistics.
Statistics *	m_sampleResStat
	Sample resolution statistics.
Statistics *	m_lineResStat
	Line resolution statistics.
Statistics *	m_aspectRatioStat
	Aspect ratio statistics.
Statistics *	m_phaseStat
	Phase angle statistics.
Statistics *	m_emissionStat
	Emission angle statistics.
Statistics *	m_incidenceStat
	Incidence angle statistics.
Statistics *	m_localSolarTimeStat
	Local solar time statistics.
Statistics *	m_localRaduisStat
	Local radius statistics (in meters).
Statistics *	m_northAzimuthStat
	North azimuth statistics.

Detailed Description

Calculates a series of statistics pertaining to a Camera.

Given a Camera pointer--or the filename of a Cube whose Camera is to be used--this class will calculate a series of statistics at initialization on the Camera. After construction, the user can retrieve statistics, compiled for every line/sample of the Camera, for the Camera's latitude, longitude, pixel resolution, sample resolution, line resolution, phase angle, emission angle, incidence angle, local solar time, meters, north azimuth, and aspect ratio.

Author:: 2011-06-14 Travis Addair

For internal use only.

History:: 2011-06-14 Travis Addair - Extracted logic from "camstats" application to create this class.

Definition at line 55 of file CameraStatistics.h.

Constructor & Destructor Documentation

Isis::CameraStatistics::CameraStatistics	(	QString	filename,
		int	sinc,
		int	linc
	)

Constructs the Camera Statistics object from a Cube filename.

This constructor will first open the cube corresponding to the "filename" parameter, then gather statistics with the Cube's Camera. Neither the Cube nor its Camera is retained after statistics gathering has completed, but the filename used to open the Cube will be output in the "User Parameters" group of the "toPvl" method. The invoker of this constructor must also specify the sample and line increments to be used during statistics gathering.

Parameters:

	filename	String filename of the Cube whose Camera will be used
	sinc	Sample increment for gathering statistics
	linc	Line increment for gathering statistics

Definition at line 27 of file CameraStatistics.cpp.

References cam, Isis::Cube::camera(), cube, init(), and Isis::Cube::open().

Isis::CameraStatistics::CameraStatistics	(	Camera *	cam,
		int	sinc,
		int	linc
	)

Constructs the Camera Statistics object from an already-existent Camera pointer.

Specifying sample and line increments of 1 will gather statistics on the entire area encompassed by the Camera, but higher numbers can be used to improve performance. Using this constructor--lacking a Cube filename--the "toPvl" method will not output the Cube filename associated with the Camera. If the user desires this information, there is a constructor that will take the filename purely for this purpose.

Parameters:

	cam	Camera pointer upon which statistics will be gathered
	sinc	Sample increment for gathering statistics
	linc	Line increment for gathering statistics

Definition at line 49 of file CameraStatistics.cpp.

References init().

Isis::CameraStatistics::CameraStatistics	(	Camera *	cam,
		int	sinc,
		int	linc,
		QString	filename
	)

Constructs the Camera Statistics object from an already-existent Camera pointer.

Specifying sample and line increments of 1 will gather statistics on the entire area encompassed by the Camera, but higher numbers can be used to improve performance. The filename provided does not serve a functional purpose during the statistics gathering process, but will report the filename used to create the Camera instance in the "User Parameters" section of the PVL output from the "toPvl" method.

Parameters:

	cam	Camera pointer upon which statistics will be gathered
	sinc	Sample increment for gathering statistics
	linc	Line increment for gathering statistics
	filename	String filename of the Cube whose Camera is being used

Definition at line 68 of file CameraStatistics.cpp.

References init().

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

Destroy this instance, deletes all the Statistics objects.

Definition at line 147 of file CameraStatistics.cpp.

References m_aspectRatioStat, m_emissionStat, m_incidenceStat, m_latStat, m_lineResStat, m_localRaduisStat, m_localSolarTimeStat, m_lonStat, m_northAzimuthStat, m_phaseStat, m_resStat, and m_sampleResStat.

Member Function Documentation

void Isis::CameraStatistics::addStats	(	Camera *	cam,
		int &	sample,
		int &	line
	)

Add statistics data to Statistics objects if the Camera position given by the provided line and sample is looking at the surface of the target.

Parameters:

	cam	Camera pointer upon which statistics are being gathered
	sample	Sample of the image to gather Camera information on
	line	Line of the image to gather Camera information on

Definition at line 207 of file CameraStatistics.cpp.

References Isis::Statistics::AddData(), Isis::Sensor::EmissionAngle(), Isis::Sensor::HasSurfaceIntersection(), Isis::Sensor::IncidenceAngle(), Isis::Camera::LineResolution(), Isis::Sensor::LocalRadius(), Isis::Sensor::LocalSolarTime(), m_aspectRatioStat, m_emissionStat, m_incidenceStat, m_latStat, m_lineResStat, m_localRaduisStat, m_localSolarTimeStat, m_lonStat, m_northAzimuthStat, m_phaseStat, m_resStat, m_sampleResStat, Isis::Distance::meters(), Isis::Camera::NorthAzimuth(), Isis::Sensor::PhaseAngle(), Isis::Camera::PixelResolution(), Isis::Camera::SampleResolution(), Isis::Camera::SetImage(), Isis::Sensor::UniversalLatitude(), and Isis::Sensor::UniversalLongitude().

Referenced by init().

PvlKeyword Isis::CameraStatistics::constructKeyword	(	QString	keyname,
		double	value,
		QString	unit = `""`
	)			const

Takes a name, value, and optionally units and constructs a PVL Keyword.

If the value is determined to be a "special pixel", then the string NULL will be used for the value.

Parameters:

	keyname	Name of keyword to generate
	value	Value to write to keyword
	unit	Optional units for keywords

Returns:: PvlKeyword Keyword constructed from input parameters

Definition at line 239 of file CameraStatistics.cpp.

References Isis::IsSpecial(), and Isis::toString().

Referenced by toPvl().

const Statistics* Isis::CameraStatistics::getAspectRatioStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Aspect Ratios of the input Camera.

Returns:: Statistics * Constant pointer to Aspect Ratio Statistics

Definition at line 129 of file CameraStatistics.h.

References m_aspectRatioStat.

const Statistics* Isis::CameraStatistics::getEmissionStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Emission Angles of the input Camera.

Returns:: Statistics * Constant pointer to Emission Angle Statistics

Definition at line 151 of file CameraStatistics.h.

References m_emissionStat.

const Statistics* Isis::CameraStatistics::getIncidenceStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Incidence Angles of the input Camera.

Returns:: Statistics * Constant pointer to Incidence Angle Statistics

Definition at line 162 of file CameraStatistics.h.

References m_incidenceStat.

const Statistics* Isis::CameraStatistics::getLatStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Universal Latitudes of the input Camera.

Returns:: Statistics * Constant pointer to Latitude Statistics

Definition at line 74 of file CameraStatistics.h.

References m_latStat.

const Statistics* Isis::CameraStatistics::getLineResStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Line Resolution of the input Camera.

Returns:: Statistics * Constant pointer to Line Resolution Statistics

Definition at line 118 of file CameraStatistics.h.

References m_lineResStat.

const Statistics* Isis::CameraStatistics::getLocalRaduisStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Local Radii (in meters) of the input Camera.

Returns:: Statistics * Constant pointer to Local Radius Statistics

Definition at line 184 of file CameraStatistics.h.

References m_localRaduisStat.

const Statistics* Isis::CameraStatistics::getLocalSolarTimeStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Local Solar Times of the input Camera.

Returns:: Statistics * Constant pointer to Local Solar Time Statistics

Definition at line 173 of file CameraStatistics.h.

References m_localSolarTimeStat.

const Statistics* Isis::CameraStatistics::getLonStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Universal Longitudes of the input Camera.

Returns:: Statistics * Constant pointer to Longitude Statistics

Definition at line 85 of file CameraStatistics.h.

References m_lonStat.

const Statistics* Isis::CameraStatistics::getNorthAzimuthStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the North Azimuths of the input Camera.

Returns:: Statistics * Constant pointer to North Azimuth Statistics

Definition at line 195 of file CameraStatistics.h.

References m_northAzimuthStat.

const Statistics* Isis::CameraStatistics::getPhaseStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Phase Angles of the input Camera.

Returns:: Statistics * Constant pointer to Phase Angle Statistics

Definition at line 140 of file CameraStatistics.h.

References m_phaseStat.

const Statistics* Isis::CameraStatistics::getResStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Pixel Resolutions of the input Camera.

Returns:: Statistics * Constant pointer to Pixel Resolution Statistics

Definition at line 96 of file CameraStatistics.h.

References m_resStat.

const Statistics* Isis::CameraStatistics::getSampleResStat ( ) const [inline]

Accessor method for inspecting the statistics gathered on the Sample Resolutions of the input Camera.

Returns:: Statistics * Constant pointer to Sample Resolution Statistics

Definition at line 107 of file CameraStatistics.h.

References m_sampleResStat.

void Isis::CameraStatistics::init	(	Camera *	cam,
		int	sinc,
		int	linc,
		QString	filename
	)			`[private]`

FileName of the Cube the Camera was derived from.

Initializes this collection of statistics by incrementing over sample/line positions in the Camera and compiling various Camera values at those locations into all the Statistics objects maintained as the persistent state of the object.

Statistics can be added to these objects later using the "addStats" method.

Parameters:

	cam	Camera pointer upon which statistics will be gathered
	sinc	Sample increment for gathering statistics
	linc	Line increment for gathering statistics
	filename	String filename of the Cube whose Camera is being used

Definition at line 86 of file CameraStatistics.cpp.

References addStats(), band, Isis::Camera::Bands(), Isis::Progress::CheckStatus(), Isis::Camera::IsBandIndependent(), line, Isis::Camera::Lines(), m_aspectRatioStat, m_emissionStat, m_incidenceStat, m_latStat, m_linc, m_lineResStat, m_localRaduisStat, m_localSolarTimeStat, m_lonStat, m_northAzimuthStat, m_phaseStat, m_resStat, m_sampleResStat, m_sinc, sample, Isis::Camera::Samples(), Isis::Camera::SetBand(), and Isis::Progress::SetMaximumSteps().

Referenced by CameraStatistics().

Pvl Isis::CameraStatistics::toPvl ( ) const

Constructs a Pvl object from the values in the various statistics objects.

The general format will look as follows:

   Group = User Parameters
     Filename (not provided for constructor w/ Camera but not filename)
     Linc
     Sinc
   End_Group
   Group = Latitude
     LatitudeMinimum
     LatitudeMaximum
     LatitudeStandardDeviation
   End_Group
   Group = Longitude
     LongitudeMinimum
     LongitudeMaximum
     LongitudeStandardDeviation
   End_Group
   Group = SampleResolution
     SampleResolutionMinimum
     SampleResolutionMaximum
     SampleResolutionStandardDeviation
   End_Group
   Group = LineResolution
     LineResolutionMinimum
     LineResolutionMaximum
     LineResolutionStandardDeviation
   End_Group
   Group = Resolution
     ResolutionMinimum
     ResolutionMaximum
     ResolutionStandardDeviation
   End_Group
   Group = AspectRatio
     AspectRatioMinimum
     AspectRatioMaximum
     AspectRatioStandardDeviation
   End_Group
   Group = PhaseAngle
     PhaseMinimum
     PhaseMaximum
     PhaseStandardDeviation
   End_Group
   Group = EmissionAngle
     EmissionMinimum
     EmissionMaximum
     EmissionStandardDeviation
   End_Group
   Group = IncidenceAngle
     IncidenceMinimum
     IncidenceMaximum
     IncidenceStandardDeviation
   End_Group
   Group = LocalSolarTime
     LocalSolarTimeMinimum
     LocalSolarTimeMaximum
     LocalSolarTimeStandardDeviation
   End_Group
   Group = LocalRadius
     LocalRadiusMinimum
     LocalRadiusMaximum
     LocalRadiusStandardDeviation
   End_Group
   Group = NorthAzimuth
     NorthAzimuthMinimum
     NorthAzimuthMaximum
     NorthAzimuthStandardDeviation
   End_Group