PCL
MorphologicalTransformation.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/MorphologicalTransformation.h - Released 2019-11-07T10:59:34Z
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-2019 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 (http://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_MorphologicalTransformation_h
53 #define __PCL_MorphologicalTransformation_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
60 #include <pcl/AutoPointer.h>
63 #include <pcl/ParallelProcess.h>
64 #include <pcl/StructuringElement.h>
66 
67 namespace pcl
68 {
69 
70 // ----------------------------------------------------------------------------
71 
82  public ParallelProcess
83 { // N.B. ImageTransformation is a virtual base class
84 public:
85 
95  MorphologicalTransformation() = default;
96 
106  {
107  m_operator = op.Clone();
108  m_structure = structure.Clone();
109  m_structure->Initialize();
110  }
111 
118  ParallelProcess( x )
119  {
120  if ( !x.m_operator.IsNull() )
121  if ( !x.m_structure.IsNull() )
122  {
123  m_operator = x.m_operator->Clone();
124  m_structure = x.m_structure->Clone();
125  }
126  }
127 
132 
137  {
138  }
139 
144  {
145  if ( &x != this )
146  {
147  (void)InterlacedTransformation::operator =( x );
148  (void)ThresholdedTransformation::operator =( x );
149  (void)ParallelProcess::operator =( x );
150  if ( !x.m_operator.IsNull() && !x.m_structure.IsNull() )
151  {
152  m_operator = x.m_operator->Clone();
153  m_structure = x.m_structure->Clone();
154  }
155  else
156  {
157  m_operator.Destroy();
158  m_structure.Destroy();
159  }
160  }
161  return *this;
162  }
163 
167  MorphologicalTransformation& operator =( MorphologicalTransformation&& ) = default;
168 
174  {
175  PCL_PRECONDITION( !m_operator.IsNull() )
176  return *m_operator;
177  }
178 
184  {
185  m_operator = op.Clone();
186  }
187 
193  {
194  PCL_PRECONDITION( !m_structure.IsNull() )
195  return *m_structure;
196  }
197 
202  void SetStructure( const StructuringElement& structure )
203  {
204  m_structure = structure.Clone();
205  m_structure->Initialize();
206  }
207 
215  {
216  PCL_PRECONDITION( !m_structure.IsNull() )
217  return m_structure->Size() + (m_structure->Size() - 1)*(InterlacingDistance() - 1);
218  }
219 
220 protected:
221 
222  AutoPointer<MorphologicalOperator> m_operator; // morphological operator
223  AutoPointer<StructuringElement> m_structure; // n-way structuring element
224 
225  /*
226  * In-Place 2-D Morphological Transformation Algorithm.
227  */
228  void Apply( pcl::Image& ) const override;
229  void Apply( pcl::DImage& ) const override;
230  void Apply( pcl::UInt8Image& ) const override;
231  void Apply( pcl::UInt16Image& ) const override;
232  void Apply( pcl::UInt32Image& ) const override;
233 
234 private:
235 
236  void Validate() const;
237 };
238 
239 // ----------------------------------------------------------------------------
240 
241 } // pcl
242 
243 #endif // __PCL_MorphologicalTransformation_h
244 
245 // ----------------------------------------------------------------------------
246 // EOF pcl/MorphologicalTransformation.h - Released 2019-11-07T10:59:34Z
Thresholded image transformation.
Abstract base class of all PCL structuring elements.
MorphologicalTransformation(const MorphologicalTransformation &x)
Interlaced image transformation in the spatial domain.
PCL root namespace.
Definition: AbstractImage.h:76
void SetOperator(const MorphologicalOperator &op)
A smart pointer with sole object ownership and optional automatic object destruction.
Definition: AutoPointer.h:241
16-bit unsigned integer image.
Abstract base class of all PCL morphological operators.
const StructuringElement & Structure() const
void Apply(FI i, FI j, F f)
Definition: Utility.h:249
virtual MorphologicalOperator * Clone() const =0
64-bit floating point real image.
Generic n-way morphological transformation.
32-bit unsigned integer image.
8-bit unsigned integer image.
virtual StructuringElement * Clone() const =0
MorphologicalTransformation(const MorphologicalOperator &op, const StructuringElement &structure)
void SetStructure(const StructuringElement &structure)
const MorphologicalOperator & Operator() const
32-bit floating point real image.
A process using multiple concurrent execution threads.