bioformats  5.1.3
TileCoverage.h
1 /*
2  * #%L
3  * OME-BIOFORMATS C++ library for image IO.
4  * Copyright © 2006 - 2015 Open Microscopy Environment:
5  * - Massachusetts Institute of Technology
6  * - National Institutes of Health
7  * - University of Dundee
8  * - Board of Regents of the University of Wisconsin-Madison
9  * - Glencoe Software, Inc.
10  * %%
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions are met:
13  *
14  * 1. Redistributions of source code must retain the above copyright notice,
15  * this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright notice,
17  * this list of conditions and the following disclaimer in the documentation
18  * and/or other materials provided with the distribution.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  *
32  * The views and conclusions contained in the software and documentation are
33  * those of the authors and should not be interpreted as representing official
34  * policies, either expressed or implied, of any organization.
35  * #L%
36  */
37 
38 #ifndef OME_BIOFORMATS_TILECOVERAGE_H
39 #define OME_BIOFORMATS_TILECOVERAGE_H
40 
41 #include <ome/bioformats/Types.h>
42 #include <ome/bioformats/PlaneRegion.h>
43 
44 #include <ome/compat/memory.h>
45 
46 namespace ome
47 {
48  namespace bioformats
49  {
50 
61  {
62  public:
64  TileCoverage();
65 
67  virtual ~TileCoverage();
68 
92  bool
93  insert(const PlaneRegion& region,
94  bool coalesce = true);
95 
108  bool
109  remove(const PlaneRegion& region);
110 
117  size() const;
118 
122  void
123  clear();
124 
136  coverage(const PlaneRegion& region) const;
137 
144  bool
145  covered(const PlaneRegion& region) const;
146 
147  protected:
148  class Impl;
150  ome::compat::shared_ptr<Impl> impl;
151  };
152 
153  }
154 }
155 
156 #endif // OME_BIOFORMATS_TILECOVERAGE_H
157 
158 /*
159  * Local Variables:
160  * mode:C++
161  * End:
162  */
dimension_size_type coverage(const PlaneRegion &region) const
Covered area within the region.
Definition: TileCoverage.cpp:320
virtual ~TileCoverage()
Destructor.
Definition: TileCoverage.cpp:201
dimension_size_type size() const
Get the number of separate regions in the coverage cache.
Definition: TileCoverage.cpp:308
Memory type substitution.
Tile coverage cache.
Definition: TileCoverage.h:60
ome::compat::shared_ptr< Impl > impl
Private implementation details.
Definition: TileCoverage.h:148
TileCoverage()
Constructor.
Definition: TileCoverage.cpp:196
Open Microscopy Environment C++ implementation.
Definition: CoreMetadata.cpp:40
void clear()
Clear the coverage cache of all covered regions.
Definition: TileCoverage.cpp:314
bool insert(const PlaneRegion &region, bool coalesce=true)
Insert a region into the coverage cache.
Definition: TileCoverage.cpp:206
bool covered(const PlaneRegion &region) const
Check if a region is completely covered.
Definition: TileCoverage.cpp:341
Internal implementation details of TileCoverage.
Definition: TileCoverage.cpp:118
std::size_t dimension_size_type
Size type for image dimensions.
Definition: Types.h:59
A rectangular region.
Definition: PlaneRegion.h:56