TileInfo.h

/*
 * #%L
 * OME-BIOFORMATS C++ library for image IO.
 * Copyright © 2006 - 2015 Open Microscopy Environment:
 *   - Massachusetts Institute of Technology
 *   - National Institutes of Health
 *   - University of Dundee
 *   - Board of Regents of the University of Wisconsin-Madison
 *   - Glencoe Software, Inc.
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) 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.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of any organization.
 * #L%
 */

#ifndef OME_BIOFORMATS_TIFF_TILEINFO_H
#define OME_BIOFORMATS_TIFF_TILEINFO_H

#include <ome/bioformats/PlaneRegion.h>
#include <ome/bioformats/tiff/Types.h>

#include <ome/compat/memory.h>

namespace ome
{
  namespace bioformats
  {
    namespace tiff
    {

      class IFD;

      class TileInfo
      {
      protected:
        friend class IFD;

        TileInfo(ome::compat::shared_ptr<IFD> ifd);

      public:
        virtual ~TileInfo();

        TileType
        tileType() const;

        dimension_size_type
        tileWidth() const;

        dimension_size_type
        tileHeight() const;

        dimension_size_type
        tileCount() const;

        dimension_size_type
        tileRowCount() const;

        dimension_size_type
        tileColumnCount() const;

        dimension_size_type
        bufferSize() const;

        dimension_size_type
        tileIndex(dimension_size_type x,
                  dimension_size_type y,
                  dimension_size_type s = 0) const;

        dimension_size_type
        tileColumn(dimension_size_type index) const;

        dimension_size_type
        tileRow(dimension_size_type index) const;

        dimension_size_type
        tileSample(dimension_size_type index) const;

        PlaneRegion
        tileRegion(dimension_size_type index,
                   const PlaneRegion& clip) const;

        PlaneRegion
        tileRegion(dimension_size_type index) const;

        std::vector<dimension_size_type>
        tileCoverage(PlaneRegion region) const;

      protected:
        class Impl;
        ome::compat::shared_ptr<Impl> impl;
      };

    }
  }
}

#endif // OME_BIOFORMATS_TIFF_TILEINFO_H

/*
 * Local Variables:
 * mode:C++
 * End:
 */