211 lines
6.8 KiB
C++
211 lines
6.8 KiB
C++
// ____ ______ __
|
|
// / __ \ / ____// /
|
|
// / /_/ // / / /
|
|
// / ____// /___ / /___ PixInsight Class Library
|
|
// /_/ \____//_____/ PCL 2.4.23
|
|
// ----------------------------------------------------------------------------
|
|
// pcl/Translation.h - Released 2022-03-12T18:59:29Z
|
|
// ----------------------------------------------------------------------------
|
|
// This file is part of the PixInsight Class Library (PCL).
|
|
// PCL is a multiplatform C++ framework for development of PixInsight modules.
|
|
//
|
|
// Copyright (c) 2003-2022 Pleiades Astrophoto S.L. All Rights Reserved.
|
|
//
|
|
// Redistribution and use in both source and binary forms, with or without
|
|
// modification, is permitted provided that the following conditions are met:
|
|
//
|
|
// 1. All redistributions of source code must retain the above copyright
|
|
// notice, this list of conditions and the following disclaimer.
|
|
//
|
|
// 2. All redistributions in binary form must reproduce the above copyright
|
|
// notice, this list of conditions and the following disclaimer in the
|
|
// documentation and/or other materials provided with the distribution.
|
|
//
|
|
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
|
|
// of their contributors, may be used to endorse or promote products derived
|
|
// from this software without specific prior written permission. For written
|
|
// permission, please contact info@pixinsight.com.
|
|
//
|
|
// 4. All products derived from this software, in any form whatsoever, must
|
|
// reproduce the following acknowledgment in the end-user documentation
|
|
// and/or other materials provided with the product:
|
|
//
|
|
// "This product is based on software from the PixInsight project, developed
|
|
// by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
|
|
//
|
|
// Alternatively, if that is where third-party acknowledgments normally
|
|
// appear, this acknowledgment must be reproduced in the product itself.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
|
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
|
|
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
|
|
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
|
|
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
|
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
|
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
|
// POSSIBILITY OF SUCH DAMAGE.
|
|
// ----------------------------------------------------------------------------
|
|
|
|
#ifndef __PCL_Translation_h
|
|
#define __PCL_Translation_h
|
|
|
|
/// \file pcl/Translation.h
|
|
|
|
#include <pcl/Defs.h>
|
|
#include <pcl/Diagnostics.h>
|
|
|
|
#include <pcl/GeometricTransformation.h>
|
|
#include <pcl/ParallelProcess.h>
|
|
|
|
namespace pcl
|
|
{
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
/*!
|
|
* \class Translation
|
|
* \brief %Image translation algorithm.
|
|
*
|
|
* ### TODO: Write a detailed description for %Translation
|
|
*/
|
|
class PCL_CLASS Translation : public InterpolatingGeometricTransformation,
|
|
public ParallelProcess
|
|
{
|
|
public:
|
|
|
|
/*!
|
|
* Constructs a %Translation object using the specified pixel interpolation
|
|
* \a p, with translation increments \a dx and \a dy in pixels.
|
|
*
|
|
* The specified pixel interpolation object \a p must remain valid while
|
|
* this object exists.
|
|
*/
|
|
Translation( PixelInterpolation& p, double dx = 0, double dy = 0 )
|
|
: InterpolatingGeometricTransformation( p )
|
|
, m_delta( dx, dy )
|
|
{
|
|
}
|
|
|
|
/*!
|
|
* Constructs a %Translation object using the specified pixel interpolation
|
|
* \a p, with translation increments in pixels given by the components of a
|
|
* point \a d in the plane.
|
|
*
|
|
* The specified pixel interpolation object \a p must remain valid while
|
|
* this object exists.
|
|
*/
|
|
Translation( PixelInterpolation& p, const DPoint& d )
|
|
: InterpolatingGeometricTransformation( p )
|
|
, m_delta( d )
|
|
{
|
|
}
|
|
|
|
/*!
|
|
* Copy constructor.
|
|
*/
|
|
Translation( const Translation& ) = default;
|
|
|
|
/*!
|
|
* Returns the translation increments in pixels for both axes, as the
|
|
* corresponding components of a point in the plane.
|
|
*/
|
|
const DPoint& Delta() const
|
|
{
|
|
return m_delta;
|
|
}
|
|
|
|
/*!
|
|
* Returns the horizontal translation increment in pixels.
|
|
*/
|
|
double DeltaX() const
|
|
{
|
|
return m_delta.x;
|
|
}
|
|
|
|
/*!
|
|
* Returns the vertical translation increment in pixels.
|
|
*/
|
|
double DeltaY() const
|
|
{
|
|
return m_delta.y;
|
|
}
|
|
|
|
/*!
|
|
* Sets the translation increments in pixels as the components of a point
|
|
* \a d in the plane.
|
|
*/
|
|
void SetDelta( const DPoint& d )
|
|
{
|
|
m_delta = d;
|
|
}
|
|
|
|
/*!
|
|
* Sets the translation increments \a dx and \a dy in pixels.
|
|
*/
|
|
void SetDelta( double dx, double dy )
|
|
{
|
|
m_delta.x = dx; m_delta.y = dy;
|
|
}
|
|
|
|
/*!
|
|
* Returns the current vector of per-channel filling values for uncovered
|
|
* image regions.
|
|
*
|
|
* See the documentation for SetFillValues() for more information.
|
|
*/
|
|
const DVector& FillValues() const
|
|
{
|
|
return m_fillValues;
|
|
}
|
|
|
|
/*!
|
|
* Sets a vector of per-channel filling values for uncovered image regions.
|
|
*
|
|
* Uncovered regions result each time an image is translated. Note that
|
|
* uncovering can be \e partial for one row or column of pixels, when
|
|
* fractional displacements are applied in the corresponding plane
|
|
* directions.
|
|
*
|
|
* By default, there are no filling values defined (and hence the returned
|
|
* vector is empty by default). When the %Translation instance is executed
|
|
* and a filling value is not defined for a channel of the target image,
|
|
* uncovered regions are filled with the minimum sample value in the native
|
|
* range of the image (usually zero).
|
|
*/
|
|
void SetFillValues( const DVector& fillValues )
|
|
{
|
|
m_fillValues = fillValues;
|
|
}
|
|
|
|
/*!
|
|
*/
|
|
void GetNewSizes( int& width, int& height ) const override
|
|
{
|
|
// No changes
|
|
}
|
|
|
|
protected:
|
|
|
|
DPoint m_delta; // displacements in pixels
|
|
DVector m_fillValues;
|
|
|
|
// Inherited from ImageTransformation.
|
|
void Apply( pcl::Image& ) const override;
|
|
void Apply( pcl::DImage& ) const override;
|
|
void Apply( pcl::UInt8Image& ) const override;
|
|
void Apply( pcl::UInt16Image& ) const override;
|
|
void Apply( pcl::UInt32Image& ) const override;
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
|
|
} // pcl
|
|
|
|
#endif // __PCL_Translation_h
|
|
|
|
// ----------------------------------------------------------------------------
|
|
// EOF pcl/Translation.h - Released 2022-03-12T18:59:29Z
|