USGS

Isis 3.0 Developer's Reference (API)

 Home

Isis::ObservationNumberList Class Reference

Needs Documentation. More...

#include <ObservationNumberList.h>

Inherits Isis::SerialNumberList.

List of all members.

Classes

struct  ObservationSet

Public Member Functions

 ObservationNumberList (const std::string &list, bool checkTarget=true)
 Creates an ObservationNumberList from a filename.
 ObservationNumberList (Isis::SerialNumberList *snlist)
 Creates an ObservationNumberList from a SerialNumberList.
 ~ObservationNumberList ()
 Destructor.
void Add (int isn, const int observationIndex, std::string observationNumber)
 Adds a new serial number index / observation number index / observation number to the SerialNumberList.
int ObservationSize () const
 How many unique observations are in the list?
int ObservationNumberMapIndex (const int serialNumberIndex)
 Return a observation index given a serial number index.
void Remove (Isis::SerialNumberList *snlist)
 Removes all of the listed serial numbers from the observation.
void Remove (const std::string &listfile)
 Removes all of the listed serial numbers from the observation.
bool HasObservationNumber (const std::string &on)
 Determines whether or not the requested observation number exists in the list.
std::string ObservationNumber (const std::string &filename)
 return an observation number given a filename
std::string ObservationNumber (int index)
 Return a observation number given an index.
std::vector< std::string > PossibleFilenames (const std::string &on)
 Return possible filenames given an observation number.
void Add (const std::string &filename, bool def2filename=false)
 Adds a new filename / serial number pair to the SerialNumberList.
bool HasSerialNumber (const std::string &sn)
 Determines whether or not the requested serial number exists in the list.
bool HasSerialNumber (QString sn)
 Delete a serial number off of the list.
void Delete (const std::string &sn)
 Delete a serial number off of the list given the Serial Number.
int Size () const
 How many serial number / filename combos are in the list.
std::string Filename (const std::string &sn)
 Return a filename given a serial number.
std::string Filename (int index)
 Return the filename at the given index.
std::string SerialNumber (const std::string &filename)
 return a serial number given a filename
std::string SerialNumber (int index)
 Return a serial number given an index.
int SerialNumberIndex (const std::string &sn)
 return a list index given a serial number
int FilenameIndex (const std::string &filename)
 Return a list index given a filename.
std::vector< std::string > PossibleSerialNumbers (const std::string &on)
 Return possible serial numbers given an observation number.

Protected Attributes

std::vector< Pair > p_pairs
std::map< std::string, int > p_serialMap
std::map< std::string, int > p_fileMap
bool p_checkTarget
std::string p_target

Detailed Description

Needs Documentation.

Needs Documentation

Author:
2007-09-17 Debbie A. Cook

Constructor & Destructor Documentation

Isis::ObservationNumberList::ObservationNumberList ( const std::string &  listfile,
bool  checkTarget = true 
)

Creates an ObservationNumberList from a filename.

Parameters:
listfile The list of files to be given observation numbers
checkTarget Boolean value that specifies whether or not to check to make sure the target names match between files added to the observationnumber list
Isis::ObservationNumberList::ObservationNumberList ( Isis::SerialNumberList *  snlist  ) 

Creates an ObservationNumberList from a SerialNumberList.

Parameters:
snlist The serial number list from which to generate an observation number list
Isis::ObservationNumberList::~ObservationNumberList (  ) 

Destructor.

Member Function Documentation

void Isis::SerialNumberList::Add ( const std::string &  filename,
bool  def2filename = false 
) [inherited]

Adds a new filename / serial number pair to the SerialNumberList.

Parameters:
filename the filename to be added
def2filename If a serial number could not be found, try to return the filename

Referenced by Isis::SerialNumberList::SerialNumberList().

void Isis::ObservationNumberList::Add ( int  isn,
const int  observationIndex,
std::string  observationNumber 
)

Adds a new serial number index / observation number index / observation number to the SerialNumberList.

Parameters:
isn The serial number index of the observation set to be added
observationIndex The observation number index of the observation set to be added
observationNumber The observation number of the observation set to be added
void Isis::SerialNumberList::Delete ( const std::string &  sn  )  [inherited]

Delete a serial number off of the list given the Serial Number.

Author:
Sharmila Prasad (9/9/2010)
Parameters:
sn - serial number

Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), and Isis::ControlNetFilter::CubeNumPointsFilter().

std::string Isis::SerialNumberList::Filename ( int  index  )  [inherited]

Return the filename at the given index.

Parameters:
index The index of the desired filename
Returns:
std::string The filename at the given index
std::string Isis::SerialNumberList::Filename ( const std::string &  sn  )  [inherited]

Return a filename given a serial number.

Parameters:
sn The serial number of the desired filename
Returns:
std::string The filename matching the input serial number

Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::BundleAdjust::Filename(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ControlNetStatistics::GenerateImageStats(), Isis::ControlNetFilter::PointCubeNamesFilter(), Isis::ControlNetFilter::PointDistanceFilter(), Isis::ControlNetFilter::PointLatLonFilter(), Isis::ControlNetFilter::PointMeasurePropertiesFilter(), Isis::ControlNetFilter::PrintCubeFileSerialNum(), Isis::ControlNetStatistics::PrintImageStats(), Isis::ControlNet::SetImages(), Isis::BundleAdjust::SetObservationMode(), and Isis::ControlNetGraphicsItem::snToFilename().

int Isis::SerialNumberList::FilenameIndex ( const std::string &  filename  )  [inherited]

Return a list index given a filename.

Parameters:
filename The filename to be searched for
Returns:
int The index of the input filename
bool Isis::ObservationNumberList::HasObservationNumber ( const std::string &  on  ) 

Determines whether or not the requested observation number exists in the list.

Parameters:
on The observation number to be checked for
Returns:
bool
bool Isis::SerialNumberList::HasSerialNumber ( QString  sn  )  [inherited]

Delete a serial number off of the list.

Determines whether or not the requested serial number exists in the list.

Parameters:
sn The serial number to be checked for
Returns:
bool
bool Isis::SerialNumberList::HasSerialNumber ( const std::string &  sn  )  [inherited]

Determines whether or not the requested serial number exists in the list.

Parameters:
sn The serial number to be checked for
Returns:
bool

Referenced by Isis::BundleAdjust::IsHeld(), Isis::ControlNet::SetImages(), and Isis::BundleAdjust::SetObservationMode().

std::string Isis::ObservationNumberList::ObservationNumber ( int  index  ) 

Return a observation number given an index.

Parameters:
index The index of the desired observation number
Returns:
std::string The observation number returned

Reimplemented from Isis::SerialNumberList.

std::string Isis::ObservationNumberList::ObservationNumber ( const std::string &  filename  ) 

return an observation number given a filename

Parameters:
filename The filename to be matched
Returns:
std::string The observation number corresponding to the input filename
int Isis::ObservationNumberList::ObservationNumberMapIndex ( const int  serialNumberIndex  ) 

Return a observation index given a serial number index.

Parameters:
serialNumberIndex The index of the serial number to map
Returns:
int The observation index mapped to the serial number

Referenced by Isis::BundleAdjust::Solve(), and Isis::BundleAdjust::SolveCholesky().

int Isis::ObservationNumberList::ObservationSize (  )  const

How many unique observations are in the list?

Returns:
int Returns number of unique observations currently in the list

Referenced by Isis::BundleAdjust::Observations(), Isis::BundleAdjust::Solve(), and Isis::BundleAdjust::SolveCholesky().

std::vector< std::string > Isis::ObservationNumberList::PossibleFilenames ( const std::string &  on  ) 

Return possible filenames given an observation number.

Parameters:
on The observation number of the desired filename
Returns:
vector<std::string> The list of possible filenames matching the input observation number
std::vector< std::string > Isis::SerialNumberList::PossibleSerialNumbers ( const std::string &  on  )  [inherited]

Return possible serial numbers given an observation number.

Parameters:
on The observation number of the possible serial number
Returns:
vector<std::string> The list of possible serial numbers matching the input observation number

References _FILEINFO_, Isis::iException::Message(), Isis::SerialNumberList::p_pairs, and Isis::iException::Programmer.

void Isis::ObservationNumberList::Remove ( const std::string &  listfile  ) 

Removes all of the listed serial numbers from the observation.

Parameters:
listfile The list of SerialNumbers to remove

References Remove().

void Isis::ObservationNumberList::Remove ( Isis::SerialNumberList *  snlist  ) 

Removes all of the listed serial numbers from the observation.

Parameters:
snlist The list of SerialNumbers to remove

Referenced by Remove().

std::string Isis::SerialNumberList::SerialNumber ( int  index  )  [inherited]

Return a serial number given an index.

Parameters:
index The index of the desired serial number
Returns:
std::string The serial number returned
std::string Isis::SerialNumberList::SerialNumber ( const std::string &  filename  )  [inherited]

return a serial number given a filename

Parameters:
filename The filename to be matched
Returns:
std::string The serial number corresponding to the input filename

Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::BundleAdjust::IsHeld(), Isis::ControlNet::SetImages(), and Isis::BundleAdjust::SetObservationMode().

int Isis::SerialNumberList::SerialNumberIndex ( const std::string &  sn  )  [inherited]

return a list index given a serial number

Parameters:
sn The serial number searched for
Returns:
int The index of the serial number
int Isis::SerialNumberList::Size (  )  const [inherited]

How many serial number / filename combos are in the list.

Returns:
int Returns number of serial numbers current in the list

Referenced by Isis::ControlNetFilter::CubeConvexHullFilter(), Isis::ControlNetFilter::CubeDistanceFilter(), Isis::ControlNetFilter::CubeNameExpressionFilter(), Isis::ControlNetFilter::CubeNumPointsFilter(), Isis::ImageOverlapSet::FindAllOverlaps(), Isis::ImageOverlapSet::FindImageOverlaps(), Isis::ControlNetStatistics::GenerateControlNetStats(), Isis::BundleAdjust::Images(), Isis::BundleAdjust::Observations(), Isis::ControlNetStatistics::PrintImageStats(), Isis::ControlNet::SetImages(), Isis::BundleAdjust::SetObservationMode(), and Isis::ControlNetGraphicsItem::snToFilename().

Member Data Documentation

bool Isis::SerialNumberList::p_checkTarget [protected, inherited]

Referenced by Isis::SerialNumberList::SerialNumberList().

std::map<std::string, int> Isis::SerialNumberList::p_fileMap [protected, inherited]
std::vector<Pair> Isis::SerialNumberList::p_pairs [protected, inherited]

Referenced by Isis::SerialNumberList::PossibleSerialNumbers().

std::map<std::string, int> Isis::SerialNumberList::p_serialMap [protected, inherited]
std::string Isis::SerialNumberList::p_target [protected, inherited]

Referenced by Isis::SerialNumberList::SerialNumberList().

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