Dims Class Reference

#include <Image/Dims.H>

List of all members.

---

Detailed Description

A simple struct to hold a pair of width/height dimensions.

We guarantee that the width and height are always non-negative, though not necessarily strictly positive. The default Dims are the 0-by-0 dimensions. Dims is strictly a const class; the width/height can only be set at construction.

Definition at line 51 of file Dims.H.

Public Member Functions
	Dims () throw ()
	Default construct with width and height == 0.
	Dims (int width, int height) throw ()
	Construct from a given width + height, which must be non-negative.
	Dims (const Dims &other) throw ()
	Copy construct.
int	w () const throw ()
	Returns the width, will always be non-negative.
int	h () const throw ()
	Returns the height, will always be non-negative.
int	sz () const throw ()
	Returns the size of the 2-D area specified by the dimensions.
int	max () const throw ()
	Returns the larger of the width and height.
int	min () const throw ()
	Returns the smaller of the width and height.
bool	isEmpty () const throw ()
	Query whether the 2-D array is empty.
bool	isNonEmpty () const throw ()
	Query whether the 2-D array is non-empty.
bool	operator== (const Dims &x) const throw ()
	See if two Dims are the same.
bool	operator!= (const Dims &x) const throw ()
	See if two Dims are different.

---

Constructor & Destructor Documentation

Dims::Dims (   )  throw () [inline]

Default construct with width and height == 0. Definition at line 181 of file Dims.H. Referenced by RGB24_to_RGB32(), RGB24_to_RGB555(), RGB24_to_RGB565(), YUV24_to_UYVYx(), YUV24_to_YUV410P(), YUV24_to_YUV411(), YUV24_to_YUV411P(), YUV24_to_YUV420P(), YUV24_to_YUV422P(), YUV24_to_YUV444(), YUV24_to_YUV444P(), and YUV24_to_YUYV().

Dims::Dims (  int  width, int  height )  throw () [inline]

Construct from a given width + height, which must be non-negative. Definition at line 186 of file Dims.H. References ASSERT, hh, and ww.

Dims::Dims (  const Dims &  other  )  throw () [inline]

Copy construct. Definition at line 193 of file Dims.H.

---

Member Function Documentation

int Dims::h (   )  const throw () [inline]

Returns the height, will always be non-negative. Definition at line 202 of file Dims.H. Referenced by SwpeScorer::accum(), addNoise(), tcl::aux_convert_from(), dummy_namespace_to_avoid_gcc411_bug_ContourChannel_C::boxDownSizeClean(), DescriptorVec::buildDV(), InferoTemporalSalBayes::buildRawDV(), DescriptorVec::buildRawDV(), buildTitle(), cartesian(), chamfer34(), SingleChannelBeoServer::check(), checkDataLength(), SceneGenerator::checkTargetPos(), Point2D< T >::clampToDims(), RawVisualCortex::combineOutputs(), IntegerRawVisualCortex::combineOutputsInt(), convertAVFrameToRGB(), convertToString(), convertVideoFrameToAVFrame(), XWindow::XWinImage::copyPixelsFrom(), corrpatch(), XWindow::XWinImage::createImage(), CT2WSRegionTrainerForm::CreateOutputImage(), crop(), cudaConvolveCleanHelper(), cudaConvolveHmax(), cudaConvolveZeroHelper(), cudaCrop(), cudaDogFilter(), cudaDogFilterHmax(), cudaGetComponents(), cudaGetRGBY(), cudaInplaceAttenuateBorders(), cudaIsDyadic(), cudaLowPass3y(), cudaLowPass5y(), cudaLowPass5yDec(), cudaLowPass9y(), cudaLowPass9yDec(), cudaLuminance(), cudaLuminanceNTSC(), cudaOptConvolve(), SpatialMetrics::deg2pix(), LandmarkDB::display(), PsychoDisplay::displayEyeTrackerCalibration(), PsychoDisplay::displayFixation(), PsychoDisplay::displayISCANcalib(), PsychoDisplay::displayRedDotFixation(), SDLdisplay::displayText(), SDLdisplay::displayVideoOverlay(), SDLdisplay::displayVideoOverlay_image(), SDLdisplay::displayVideoOverlay_pos(), ContourChannel::doInput(), doQuestion(), doRescale(), downSize(), downSizeClean(), PlotBufferList::draw(), XWindow::drawImage(), LocalizationMapEntity::drawMe(), drawMeters(), TemplateMatchChannel::drawResults(), InferotemporalCortexI::evolve(), V2::evolve2(), extensionFor(), FfmpegEncoder::FfmpegEncoder(), FourierEngine< T >::fft(), find1394mode(), V2::findLines(), FourierEngine< T >::FourierEngine(), FourierInvEngine< T >::FourierInvEngine(), PyrFoveator::foveate(), IntegerInput::fromVideo(), fromVideoHM12(), fromVideoYUV410P(), fromVideoYUV411P(), fromVideoYUV420P(), fromVideoYUV422(), fromVideoYUV422P(), fromVideoYUV444P(), ObjRec::generateNewEdgeState(), ObjRec::generateNewLineState(), ObjRec::generateNewSquareState(), TestImages::generateScene(), EyeTrackerISCAN::getCalibrationSet(), ContourConnection::getCenter(), GenericFrameSpec::getDescription(), SpectralResidualChannel::Downsizer::getDownsized(), VideoFrame::getFlippedHoriz(), FrameIstream::getHeight(), GenericFrame::getHeight(), Layout< byte >::getHeight(), SDLdisplay::getHeight(), InputFrame::getHeight(), SearchArray::getImage(), ZeroChannel::getMapDims(), SingleChannel::getMapDims(), ObjDetChannel::getMapDims(), IntegerSimpleChannel::getMapDims(), ForegroundDetectionChannel::getMapDims(), VisualObjectMatch::getMatchImage(), VisualEvent::getMaxObjectDims(), SceneGenerator::getObjFromPos(), RetinaSpaceVariant::getOutput(), RetinaStd::getOutput(), SpectralResidualChannel::getOutput(), getRaoJetMap(), RetinaSpaceVariant::getRawInputRectangle(), RetinaStd::getRawInputRectangle(), Retina::getRawInputRectangle(), SwpeScorer::getScoreString(), Stimulus2D::getTotalTime(), SimulationViewerStd::getTraj(), SimulationViewerNerdCam::getTraj(), SimulationViewerEyeMvt::getTraj(), SimulationViewerCompress::getTraj(), VisualObjectMatch::getTransfTestOutline(), Image< T >::getValInterpScaled(), dummy_namespace_to_avoid_gcc411_bug_YuvParser_C::getVideoFileInfoFromFilename(), IEEE1394grabber::grabPrealloc(), XCgrabberFlex::grabRaw(), grid_averages(), ArrayData< T >::h(), SceneUnderstanding::highOrderRec(), FourierInvEngine< T >::ifft(), ifsDims(), ImageInfo::ImageInfo(), QuickTimeGrabber::Impl::Impl(), infoFFT(), ObjRec::initialProposal(), inplaceAttenuateBorders(), VisualBufferStd::input(), ImageTk< T >::Instance::Instance(), CT2WSRegionTrainerForm::interpolateVector(), intgDownSize(), intgInplaceAttenuateBorders(), intgRescale(), intgShiftImage(), isDyadic(), EyeData::isWithin(), Layout< T >::Layout(), learnImage(), Patch::load(), LogPolarTransform::LogPolarTransform(), main(), VideoFrame::makeBobDeinterlaced(), NeoBrain::moveHeadToTarget(), MrawvDecoder::MrawvDecoder(), myDownSize(), Beobot2_GistSalLocalizerMasterI::objectUpdateBelief(), GSlocalizer::objectUpdateBelief(), omniCorrectGen(), SDLdisplay::openDisplay(), operator *(), operator+(), operator-(), operator/(), operator<<(), RasterInputOptions::paramChanged(), SpatialMetrics::paramChanged(), EnvSimulationViewer::paramChanged(), InputMbariFrameSeries::peekDims(), SpatialMetrics::pix2deg(), World2DInput::placeSquare(), VectorField::plotField(), Point2D< T >::Point2D(), V4d::proposeParticles(), GameOfLifeInput::readFrame(), EyeSFile::readUpTo(), TrainingSet::recordSample(), XWindow::XWinImage::redraw(), playlist::redraw(), rescaleBilinear(), rescaleNI(), retinalToVisualBuffer(), retinexDepth(), LateralGeniculateNucleusI::run(), saliencyChamfer34(), SearchArray::saveCoords(), MbariResultViewer::saveSingleEventFrame(), scaleBlock(), QtImageFrame::Impl::scaledDims(), Stimulus2D::setConfigInfo(), LayerDecoder::setDecoder(), DescriptorVec::setFovea(), QtImageFrame::Impl::setInitialDims(), CorticalTransform::setup(), shiftImage(), SHOWIMG(), VisualBufferStd::start1(), XCgrabber::start1(), V4Lgrabber::start1(), SDLdisplay::start2(), V2::step(), submain(), V2::sumJGx(), V2::sumPsiGy(), V2::sumWGx(), testBiasedSceneALOI(), testSceneALOI(), SimEventInputFrame::toString(), SceneRec::trainFeature(), ResizeSpec::transformDims(), QtImageFrame::Impl::updateSize(), TwoHalfDSketch::vanishingPoints(), visualBufferToRetinal(), warp3D(), MgzEncoder::writeFrame(), SDLdisplayStream::writeFrame(), writeImageToStream(), BitObject::writeToStream(), UcbMpegEncoder::writeVideoFrame(), FfmpegEncoder::writeVideoFrame(), XWindow::XWindow(), XWindow::XWinImage::XWinImage(), YUV24_to_YUV410P(), YUV24_to_YUV411P(), YUV24_to_YUV420P(), YUV24_to_YUV422P(), YUV410P_to_YUV24(), yuv411p_to_VideoFrame(), YUV411P_to_YUV24(), yuv420p_to_VideoFrame(), YUV420P_to_YUV24(), yuv422p_to_VideoFrame(), and YUV422P_to_YUV24().

bool Dims::isEmpty (   )  const throw () [inline]

Query whether the 2-D array is empty. (empty means that at least one of the width or height is 0). Definition at line 218 of file Dims.H. References sz(). Referenced by SwpeScorer::accum(), Point2D< T >::clampToDims(), convertAVFrameToRGB(), MbariResultViewer::displayImage(), doResizeFrame(), doResizeImage(), ResizeSpec::fromString(), ChannelBase::getInputDims(), RetinaSpaceVariant::getOutput(), RetinaStd::getOutput(), MrawvDecoder::MrawvDecoder(), XMLInput::readFrame(), InputMbariFrameSeries::readRGB(), QtImageFrame::Impl::scaledDims(), ChannelBase::setInputDims(), warp3D(), XWindow::XWindow(), yuv411p_to_VideoFrame(), yuv420p_to_VideoFrame(), and yuv422p_to_VideoFrame().

bool Dims::isNonEmpty (   )  const throw () [inline]

Query whether the 2-D array is non-empty. (i.e. both width and height are positive, non-zero). Definition at line 222 of file Dims.H. References sz(). Referenced by dummy_namespace_to_avoid_gcc411_bug_ContourChannel_C::boxDownSizeClean(), doResizeImage(), downSizeClean(), SpectralResidualChannel::getOutput(), SimulationViewerStd::getTraj(), SimulationViewerNerdCam::getTraj(), ChannelBase::hasInput(), VideoFrame::initialized(), Layout< byte >::initialized(), IntegerInput::initialized(), myDownSize(), SpatialMetrics::paramChanged(), EnvSimulationViewer::paramChanged(), InputFrameSeries::peekFrameSpec(), TrainingSet::scaledInputDims(), VisualBufferStd::start1(), EyeSFile::start2(), and QtImageFrame::Impl::updateSize().

int Dims::max (   )  const throw () [inline]

Returns the larger of the width and height. Definition at line 210 of file Dims.H. Referenced by centerSurround(), SpectralResidualChannel::getOutput(), and intgCenterSurround().

int Dims::min (   )  const throw () [inline]

Returns the smaller of the width and height. Definition at line 214 of file Dims.H.

bool Dims::operator!= (  const Dims &  x  )  const throw () [inline]

See if two Dims are different. Definition at line 229 of file Dims.H. References hh, ww, and x.

bool Dims::operator== (  const Dims &  x  )  const throw () [inline]

See if two Dims are the same. Definition at line 225 of file Dims.H. References hh, ww, and x.

int Dims::sz (   )  const throw () [inline]

Returns the size of the 2-D area specified by the dimensions. (i.e. width * height). Definition at line 206 of file Dims.H. Referenced by ArrayData< T >::ArrayData(), SDLdisplay::clearBackBuffer(), TaskRelevanceMapGistClassify::computeGistDist(), corrpatch(), cudaAbs(), cudaAddImages(), cudaClear(), cudaDivideImages(), cudaGaborFilter3(), cudaGaussian(), cudaGetAvg(), cudaGetMax(), cudaGetMin(), cudaGetMinMax(), cudaGetMinMaxAvg(), cudaGetSum(), cudaInplaceAddBGnoise2(), cudaInplaceAddImages(), cudaInplaceAddScalar(), cudaInplaceAttenuateBorders(), cudaInplaceClamp(), cudaInplaceDivideImages(), cudaInplaceDivideScalar(), cudaInplaceMultiplyImages(), cudaInplaceMultiplyScalar(), cudaInplaceNormalize(), cudaInplaceRectify(), cudaInplaceSubtractImages(), cudaInplaceSubtractScalar(), cudaMultiplyImages(), cudaQuadEnergy(), cudaRandomMT(), cudaSqrt(), cudaSquared(), cudaSubtractImages(), cudaTakeMax(), cudaXFilter(), cudaYFilter(), ArrayData< T >::end(), ArrayData< T >::endw(), fromARGB(), fromBayer(), fromBayerU16(), fromMono(), fromRGB(), fromRGB555(), fromRGB565(), IntegerInput::fromVideo(), fromVideoHM12(), fromVideoYUV24(), fromVideoYUV410P(), fromVideoYUV411(), fromVideoYUV411P(), fromVideoYUV420P(), fromVideoYUV422(), fromVideoYUV422P(), fromVideoYUV444(), fromVideoYUV444P(), SearchArray::generateBackground(), LeastSquaresLearner::getBiasMap(), getFrameSize(), Image< T >::getSize(), CudaImage< T >::getSize(), XCgrabberFlex::grabRaw(), XCgrabber::grabRaw(), GREY_to_YUV24(), isEmpty(), isNonEmpty(), PatchSet::load(), main(), TrainingSet::numPositions(), CudaImage< T >::operator *(), CudaImage< T >::operator *=(), CudaImage< T >::operator+(), CudaImage< T >::operator+=(), CudaImage< T >::operator-(), CudaImage< T >::operator-=(), CudaImage< T >::operator/(), CudaImage< T >::operator/=(), EnvSimulationViewer::paramChanged(), MgzDecoder::readFrame(), InputFrameSeries::Impl::readFrame(), reshape(), RGB24_to_GREY(), RGB24_to_RGB32(), RGB24_to_RGB555(), RGB24_to_RGB565(), RGB24_to_YUV24(), RGB32_to_YUV24(), PatchSet::save(), Image< T >::size(), CudaImage< T >::size(), XCgrabberFlex::start1(), XCgrabber::start1(), submain(), VideoFrame::toYuvComponents(), MgzEncoder::writeFrame(), YUV24_to_UYVYx(), YUV24_to_YUV410P(), YUV24_to_YUV411(), YUV24_to_YUV411P(), YUV24_to_YUV420P(), YUV24_to_YUV422P(), YUV24_to_YUV444(), YUV24_to_YUV444P(), YUV24_to_YUYV(), YUV410P_to_YUV24(), YUV411_to_YUV24(), YUV411P_to_YUV24(), YUV420P_to_YUV24(), YUV422P_to_YUV24(), YUV444_to_YUV24(), YUV444P_to_YUV24(), YUYV_to_YUV24(), and ArrayData< T >::~ArrayData().

int Dims::w (   )  const throw () [inline]

Returns the width, will always be non-negative. Definition at line 198 of file Dims.H. Referenced by SwpeScorer::accum(), addNoise(), tcl::aux_convert_from(), BiasValImage::BiasValImage(), dummy_namespace_to_avoid_gcc411_bug_ContourChannel_C::boxDownSizeClean(), DescriptorVec::buildDV(), InferoTemporalSalBayes::buildRawDV(), DescriptorVec::buildRawDV(), buildTitle(), cartesian(), chamfer34(), SingleChannelBeoServer::check(), checkDataLength(), SceneGenerator::checkTargetPos(), Point2D< T >::clampToDims(), RawVisualCortex::combineOutputs(), IntegerRawVisualCortex::combineOutputsInt(), SubmapAlgorithmBiased::compute(), convertAVFrameToRGB(), convertToString(), convertVideoFrameToAVFrame(), XWindow::XWinImage::copyPixelsFrom(), corrpatch(), XWindow::XWinImage::createImage(), CT2WSRegionTrainerForm::CreateOutputImage(), crop(), cudaConvolveCleanHelper(), cudaConvolveHmax(), cudaConvolveZeroHelper(), cudaCrop(), cudaDogFilter(), cudaDogFilterHmax(), cudaGetComponents(), cudaGetRGBY(), cudaInplaceAttenuateBorders(), cudaIsDyadic(), cudaLowPass3x(), cudaLowPass3y(), cudaLowPass5x(), cudaLowPass5xDec(), cudaLowPass5y(), cudaLowPass5yDec(), cudaLowPass9x(), cudaLowPass9xDec(), cudaLowPass9y(), cudaLowPass9yDec(), cudaLuminance(), cudaLuminanceNTSC(), cudaOptConvolve(), SpatialMetrics::deg2pix(), LandmarkDB::display(), PsychoDisplay::displayEyeTrackerCalibration(), PsychoDisplay::displayFixation(), PsychoDisplay::displayISCANcalib(), PsychoDisplay::displayRedDotFixation(), SDLdisplay::displayText(), SDLdisplay::displayVideoOverlay(), SDLdisplay::displayVideoOverlay_image(), SDLdisplay::displayVideoOverlay_pos(), ContourChannel::doInput(), doQuestion(), doRescale(), downSize(), downSizeClean(), PlotBufferList::draw(), XWindow::drawImage(), LocalizationMapEntity::drawMe(), drawMeters(), TemplateMatchChannel::drawResults(), InferotemporalCortexI::evolve(), BeoLRF::evolve(), V2::evolve2(), extensionFor(), FfmpegEncoder::FfmpegEncoder(), FourierEngine< T >::fft(), find1394mode(), V2::findLines(), FourierEngine< T >::FourierEngine(), FourierInvEngine< T >::FourierInvEngine(), PyrFoveator::foveate(), IntegerInput::fromVideo(), fromVideoHM12(), fromVideoYUV410P(), fromVideoYUV411P(), fromVideoYUV420P(), fromVideoYUV422(), fromVideoYUV422P(), fromVideoYUV444P(), ObjRec::generateNewEdgeState(), ObjRec::generateNewLineState(), TestImages::generateScene(), Beobot2_GistSalLocalizerMasterI::getBeliefImage(), GSlocalizer::getBeliefImage(), EyeTrackerISCAN::getCalibrationSet(), ContourConnection::getCenter(), SpectralResidualChannel::Downsizer::getDownsized(), VideoFrame::getFlippedHoriz(), SearchArray::getImage(), InferotemporalCortexI::getLandmarkInfo(), World2DInput::getLineLength(), ZeroChannel::getMapDims(), ObjDetChannel::getMapDims(), ForegroundDetectionChannel::getMapDims(), VisualObjectMatch::getMatchImage(), VisualEvent::getMaxObjectDims(), SoxChannel::getNonlinearResponse(), SceneGenerator::getObjFromPos(), RetinaSpaceVariant::getOutput(), RetinaStd::getOutput(), SpectralResidualChannel::getOutput(), getRaoJetMap(), RetinaSpaceVariant::getRawInputRectangle(), RetinaStd::getRawInputRectangle(), Retina::getRawInputRectangle(), SwpeScorer::getScoreString(), GetSaliency::getSubMaps(), SimulationViewerStd::getTraj(), SimulationViewerNerdCam::getTraj(), SimulationViewerEyeMvt::getTraj(), SimulationViewerCompress::getTraj(), VisualObjectMatch::getTransfTestOutline(), Image< T >::getValInterpScaled(), dummy_namespace_to_avoid_gcc411_bug_YuvParser_C::getVideoFileInfoFromFilename(), FrameIstream::getWidth(), GenericFrame::getWidth(), Layout< byte >::getWidth(), SDLdisplay::getWidth(), InputFrame::getWidth(), lobot::grab_mode_enums(), IEEE1394grabber::grabPrealloc(), XCgrabberFlex::grabRaw(), grid_averages(), FourierInvEngine< T >::ifft(), ifsDims(), ImageInfo::ImageInfo(), QuickTimeGrabber::Impl::Impl(), InferotemporalCortexI::InferotemporalCortexI(), infoFFT(), ObjRec::initialProposal(), inplaceAttenuateBorders(), VisualBufferStd::input(), ImageTk< T >::Instance::Instance(), CT2WSRegionTrainerForm::interpolateVector(), intgDownSize(), intgInplaceAttenuateBorders(), intgRescale(), intgShiftImage(), isDyadic(), EyeData::isWithin(), Layout< T >::Layout(), learnImage(), Patch::load(), LogPolarTransform::LogPolarTransform(), main(), VideoFrame::makeBobDeinterlaced(), NeoBrain::moveHeadToTarget(), MrawvDecoder::MrawvDecoder(), myDownSize(), Stimulus2D::next(), Beobot2_GistSalLocalizerMasterI::objectUpdateBelief(), GSlocalizer::objectUpdateBelief(), omniCorrectGen(), SDLdisplay::openDisplay(), operator *(), operator+(), operator-(), operator/(), operator<<(), TrainingSet::p2p(), RasterInputOptions::paramChanged(), SpatialMetrics::paramChanged(), EnvSimulationViewer::paramChanged(), InputMbariFrameSeries::peekDims(), SpatialMetrics::pix2deg(), World2DInput::placeSquare(), VectorField::plotField(), Point2D< T >::Point2D(), SingleChannel::postProcessMap(), V4d::proposeParticles(), GameOfLifeInput::readFrame(), EyeSFile::readUpTo(), TrainingSet::recordSample(), XWindow::XWinImage::redraw(), playlist::redraw(), rescaleBilinear(), rescaleNI(), lobot::restrict_grab_size(), retinalToVisualBuffer(), retinexDepth(), LateralGeniculateNucleusI::run(), Nv2UiJob::run(), saliencyChamfer34(), SearchArray::saveCoords(), MbariResultViewer::saveSingleEventFrame(), scaleBlock(), QtImageFrame::Impl::scaledDims(), Stimulus2D::setConfigInfo(), LayerDecoder::setDecoder(), DescriptorVec::setFovea(), QtImageFrame::Impl::setInitialDims(), CorticalTransform::setup(), shift(), shiftImage(), SHOWIMG(), VisualBufferStd::start1(), XCgrabber::start1(), V4Lgrabber::start1(), SDLdisplay::start2(), V2::step(), submain(), V2::sumJGx(), V2::sumPsiGy(), V2::sumWGx(), testBiasedSceneALOI(), testSceneALOI(), SimEventInputFrame::toString(), SceneRec::trainFeature(), ResizeSpec::transformDims(), SubGUI::update(), GeneralGUI::update(), QtImageFrame::Impl::updateSize(), BiasValImage::updateValues(), TwoHalfDSketch::vanishingPoints(), visualBufferToRetinal(), ArrayData< T >::w(), warp3D(), MgzEncoder::writeFrame(), SDLdisplayStream::writeFrame(), writeImageToStream(), BitObject::writeToStream(), UcbMpegEncoder::writeVideoFrame(), FfmpegEncoder::writeVideoFrame(), XWindow::XWindow(), XWindow::XWinImage::XWinImage(), YUV24_to_UYVYx(), YUV24_to_YUV410P(), YUV24_to_YUV411(), YUV24_to_YUV411P(), YUV24_to_YUV420P(), YUV24_to_YUV422P(), YUV24_to_YUYV(), YUV410P_to_YUV24(), yuv411p_to_VideoFrame(), YUV411P_to_YUV24(), yuv420p_to_VideoFrame(), YUV420P_to_YUV24(), yuv422p_to_VideoFrame(), and YUV422P_to_YUV24().

---

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

• src/Image/Dims.H

---