PCL
InterlacedTransformation.h
Go to the documentation of this file.
1
// ____ ______ __
2
// / __ \ / ____// /
3
// / /_/ // / / /
4
// / ____// /___ / /___ PixInsight Class Library
5
// /_/ \____//_____/ PCL 2.6.5
6
// ----------------------------------------------------------------------------
7
// pcl/InterlacedTransformation.h - Released 2024-01-13T15:47:58Z
8
// ----------------------------------------------------------------------------
9
// This file is part of the PixInsight Class Library (PCL).
10
// PCL is a multiplatform C++ framework for development of PixInsight modules.
11
//
12
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13
//
14
// Redistribution and use in both source and binary forms, with or without
15
// modification, is permitted provided that the following conditions are met:
16
//
17
// 1. All redistributions of source code must retain the above copyright
18
// notice, this list of conditions and the following disclaimer.
19
//
20
// 2. All redistributions in binary form must reproduce the above copyright
21
// notice, this list of conditions and the following disclaimer in the
22
// documentation and/or other materials provided with the distribution.
23
//
24
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25
// of their contributors, may be used to endorse or promote products derived
26
// from this software without specific prior written permission. For written
27
// permission, please contact info@pixinsight.com.
28
//
29
// 4. All products derived from this software, in any form whatsoever, must
30
// reproduce the following acknowledgment in the end-user documentation
31
// and/or other materials provided with the product:
32
//
33
// "This product is based on software from the PixInsight project, developed
34
// by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35
//
36
// Alternatively, if that is where third-party acknowledgments normally
37
// appear, this acknowledgment must be reproduced in the product itself.
38
//
39
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49
// POSSIBILITY OF SUCH DAMAGE.
50
// ----------------------------------------------------------------------------
51
52
#ifndef __PCL_InterlacedTransformation_h
53
#define __PCL_InterlacedTransformation_h
54
56
57
#include <
pcl/Defs.h
>
58
#include <pcl/Diagnostics.h>
59
60
#include <
pcl/ImageTransformation.h
>
61
#include <
pcl/Utility.h
>
62
63
namespace
pcl
64
{
65
66
// ----------------------------------------------------------------------------
67
88
class
PCL_CLASS
InterlacedTransformation
:
public
virtual
ImageTransformation
89
{
90
public
:
91
96
InterlacedTransformation
(
int
n = 1 )
97
: m_distance(
pcl
::
Max
( 1, n ) )
98
{
99
PCL_PRECONDITION( n > 0 )
100
}
101
105
InterlacedTransformation
(
const
InterlacedTransformation
& ) =
default
;
106
110
~InterlacedTransformation
()
override
111
{
112
}
113
122
bool
IsInterlaced
()
const
123
{
124
return
m_distance > 1;
125
}
126
133
int
InterlacingDistance
()
const
134
{
135
return
m_distance;
136
}
137
148
void
SetInterlacingDistance
(
int
n )
149
{
150
PCL_PRECONDITION( n > 0 )
151
m_distance =
pcl::Max
( 1, n );
152
}
153
161
void
DisableInterlacing
()
162
{
163
SetInterlacingDistance( 1 );
164
}
165
166
private
:
167
168
/*
169
* Interlacing distance in pixels
170
*/
171
int
m_distance = 1;
172
};
173
174
// ----------------------------------------------------------------------------
175
176
}
// pcl
177
178
#endif // __PCL_InterlacedTransformation_h
179
180
// ----------------------------------------------------------------------------
181
// EOF pcl/InterlacedTransformation.h - Released 2024-01-13T15:47:58Z
pcl
PCL root namespace.
Definition:
AbstractImage.h:76
pcl::InterlacedTransformation::SetInterlacingDistance
void SetInterlacingDistance(int n)
Definition:
InterlacedTransformation.h:148
ImageTransformation.h
pcl::ImageTransformation
Root base class of all PCL image transformations.
Definition:
ImageTransformation.h:90
pcl::InterlacedTransformation
Interlaced image transformation in the spatial domain.
Definition:
InterlacedTransformation.h:88
Utility.h
pcl::InterlacedTransformation::IsInterlaced
bool IsInterlaced() const
Definition:
InterlacedTransformation.h:122
pcl::Max
constexpr const T & Max(const T &a, const T &b) noexcept
Definition:
Utility.h:119
pcl::InterlacedTransformation::InterlacedTransformation
InterlacedTransformation(int n=1)
Definition:
InterlacedTransformation.h:96
pcl::InterlacedTransformation::~InterlacedTransformation
~InterlacedTransformation() override
Definition:
InterlacedTransformation.h:110
pcl::InterlacedTransformation::InterlacingDistance
int InterlacingDistance() const
Definition:
InterlacedTransformation.h:133
pcl::InterlacedTransformation::DisableInterlacing
void DisableInterlacing()
Definition:
InterlacedTransformation.h:161
Defs.h
InterlacedTransformation.h
Generated on Sun Jan 14 2024 20:52:44 for PCL by
1.8.17