001/*
002 * $RCSfile: CoordInfo.java,v $
003 * $Revision: 1.1 $
004 * $Date: 2005/02/11 05:01:59 $
005 * $State: Exp $
006 *
007 * Class:                   CoordInfo
008 *
009 * Description: Used to store the coordinates of code-blocks/packets
010 *
011 *
012 *
013 * COPYRIGHT:
014 *
015 * This software module was originally developed by Raphaël Grosbois and
016 * Diego Santa Cruz (Swiss Federal Institute of Technology-EPFL); Joel
017 * Askelöf (Ericsson Radio Systems AB); and Bertrand Berthelot, David
018 * Bouchard, Félix Henry, Gerard Mozelle and Patrice Onno (Canon Research
019 * Centre France S.A) in the course of development of the JPEG2000
020 * standard as specified by ISO/IEC 15444 (JPEG 2000 Standard). This
021 * software module is an implementation of a part of the JPEG 2000
022 * Standard. Swiss Federal Institute of Technology-EPFL, Ericsson Radio
023 * Systems AB and Canon Research Centre France S.A (collectively JJ2000
024 * Partners) agree not to assert against ISO/IEC and users of the JPEG
025 * 2000 Standard (Users) any of their rights under the copyright, not
026 * including other intellectual property rights, for this software module
027 * with respect to the usage by ISO/IEC and Users of this software module
028 * or modifications thereof for use in hardware or software products
029 * claiming conformance to the JPEG 2000 Standard. Those intending to use
030 * this software module in hardware or software products are advised that
031 * their use may infringe existing patents. The original developers of
032 * this software module, JJ2000 Partners and ISO/IEC assume no liability
033 * for use of this software module or modifications thereof. No license
034 * or right to this software module is granted for non JPEG 2000 Standard
035 * conforming products. JJ2000 Partners have full right to use this
036 * software module for his/her own purpose, assign or donate this
037 * software module to any third party and to inhibit third parties from
038 * using this software module for non JPEG 2000 Standard conforming
039 * products. This copyright notice must be included in all copies or
040 * derivative works of this software module.
041 *
042 * Copyright (c) 1999/2000 JJ2000 Partners.
043 * */
044package jj2000.j2k.codestream;
045
046/**
047 * This class is used to store the coordinates of objects such as code-blocks
048 * or precincts. As this is an abstract class, it cannot be used directly but
049 * derived classes have been created for code-blocks and packets
050 * (CBlkCoordInfo and PrecCoordInfo).
051 *
052 * @see PrecCoordInfo
053 * @see CBlkCoordInfo
054 * */
055public abstract class CoordInfo {
056
057    /** Horizontal upper left coordinate in the subband */
058    public int ulx;
059
060    /** Vertical upper left coordinate in the subband */
061    public int uly;
062
063    /** Object's width */
064    public int w;
065
066    /** Object's height */
067    public int h;
068
069    /**
070     * Constructor. Creates a CoordInfo object.
071     *
072     * @param ulx The horizontal upper left coordinate in the subband
073     *
074     * @param uly The vertical upper left coordinate in the subband
075     *
076     * @param w The width
077     *
078     * @param h The height
079     *
080     * @param idx The object's index
081     * */
082    public CoordInfo(int ulx, int uly, int w, int h) {
083        this.ulx = ulx;
084        this.uly = uly;
085        this.w = w;
086        this.h = h;
087    }
088
089    /** Empty contructor */
090    public CoordInfo() { }
091
092    /**
093     * Returns object's information in a String
094     *
095     * @return String with object's information
096     * */
097    public String toString() {
098        return "ulx="+ulx+", uly="+uly+", w="+w+", h="+h;
099    }
100}