Apply corrections to a cube label for subarea extraction. More...

#include <SubArea.h>

Collaboration diagram for Isis::SubArea:

Public Member Functions
	SubArea ()

	~SubArea ()

void	SetSubArea (const int orignl, const int origns, const int sl, const int ss, const int el, const int es, const double linc, const double sinc)
	Defines the subarea. More...

void	UpdateLabel (Cube icube, Cube ocube, PvlGroup &results)
	Modifies a label for a file containing a subarea. More...

Detailed Description

Apply corrections to a cube label for subarea extraction.

This class is used to apply corrections to a cube label when a subarea has been extracted. It is a base class which will take the cube label from the original cube file along with subarea information and generate a corrected cube label for the output cube file.

If you would like to see SubArea being used in implementation, see crop, reduce, enlarge, cropspecial, or pad.

Author: 2009-10-02 Janet Barrett

Constructor & Destructor Documentation

◆ SubArea()

Isis::SubArea::SubArea ( )

inline

◆ ~SubArea()

Isis::SubArea::~SubArea ( )

inline

Member Function Documentation

◆ SetSubArea()

void Isis::SubArea::SetSubArea	(	const int	orignl,
		const int	origns,
		const int	sl,
		const int	ss,
		const int	el,
		const int	es,
		const double	linc,
		const double	sinc
	)

Defines the subarea.

Parameters

orignl	This is the number of lines in the original image.
origns	This is the number of samples in the original image.
sl	This is the line in the original image where the subarea will start at. This value must be greater than or equal to 1 and less than or equal to the number of lines in the original image.
ss	This is the sample in the original image where the subarea will start at. This value must be greater than or equal to 1 and less than or equal to the number of samples in the original image.
el	This is the ending line of the subarea to extract from the original image. This value must be greater than or equal to sl and less than or equal to the number of lines in the original image. The actual number of lines that will be in the subarea will be (el-sl+1)/linc.
es	This is the ending sample of the subarea to extract from the original image. This value must be greater than or equal to ss and less than or equal to the number of samples in the original image. The actual number of samples that will be in the subarea will be (es-ss+1)/sinc.
linc	This is the line increment that will be used to extract the subarea from the original image. It must be greater than 0.
sinc	This is the sample increment that will be used to extract the subarea from the original image. It must be greater than 0.

References _FILEINFO_.

Referenced by Isis::Reduce::UpdateOutputLabel(), and Isis::Enlarge::UpdateOutputLabel().

◆ UpdateLabel()

void Isis::SubArea::UpdateLabel	(	Cube *	icube,
		Cube *	ocube,
		PvlGroup &	results
	)

Modifies a label for a file containing a subarea.

The AlphaCube, Mapping, and Instrument groups are all affected when a subarea is extracted from another file. If the linc is not equal to the sinc, then the Instrument and Mapping groups will be removed from the label because they will no longer be valid. If the linc is equal to the sinc and they are not equal to 1, then the map scale and resolution in the Mapping group needs to be updated. The latitude and longitude ranges become invalid when the subarea does not cover the entire sample and line range of the original cube. Update the upper left corner x,y values if the projection is still valid and the starting line and/or starting sample have been changed from their location in the original file.