affyfusion-109/src/affymetrix/gcos/chp/BackgroundZoneInfo.java

Code
Comments
Other
Rev Date Author Line
11 13 Sep 07 nicklas 1 /////////////////////////////////////////////////////////////////
11 13 Sep 07 nicklas 2 //
11 13 Sep 07 nicklas 3 // Copyright (C) 2005 Affymetrix, Inc.
11 13 Sep 07 nicklas 4 //
11 13 Sep 07 nicklas 5 // This library is free software; you can redistribute it and/or modify
11 13 Sep 07 nicklas 6 // it under the terms of the GNU Lesser General Public License as published
11 13 Sep 07 nicklas 7 // by the Free Software Foundation; either version 2.1 of the License,
11 13 Sep 07 nicklas 8 // or (at your option) any later version.
11 13 Sep 07 nicklas 9 //
11 13 Sep 07 nicklas 10 // This library is distributed in the hope that it will be useful, but
11 13 Sep 07 nicklas 11 // WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
11 13 Sep 07 nicklas 12 // or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
11 13 Sep 07 nicklas 13 // for more details.
11 13 Sep 07 nicklas 14 //
11 13 Sep 07 nicklas 15 // You should have received a copy of the GNU Lesser General Public License
11 13 Sep 07 nicklas 16 // along with this library; if not, write to the Free Software Foundation, Inc.,
11 13 Sep 07 nicklas 17 // 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
11 13 Sep 07 nicklas 18 //
11 13 Sep 07 nicklas 19 /////////////////////////////////////////////////////////////////
11 13 Sep 07 nicklas 20
11 13 Sep 07 nicklas 21 package affymetrix.gcos.chp;
11 13 Sep 07 nicklas 22
11 13 Sep 07 nicklas 23 import java.util.*;
11 13 Sep 07 nicklas 24         
11 13 Sep 07 nicklas 25 /** Information about all background zones on an array. */
11 13 Sep 07 nicklas 26 public class BackgroundZoneInfo {
11 13 Sep 07 nicklas 27     
11 13 Sep 07 nicklas 28     /** A vector of BackgroundZoneType objects. */
11 13 Sep 07 nicklas 29     private Vector zones;
11 13 Sep 07 nicklas 30         
11 13 Sep 07 nicklas 31     /** Gets the number of zones.
11 13 Sep 07 nicklas 32      * @return The number of zones on the array.
11 13 Sep 07 nicklas 33      */
11 13 Sep 07 nicklas 34     public int getNumberZones() { return zones.size(); }
11 13 Sep 07 nicklas 35     
11 13 Sep 07 nicklas 36     /** Adds a zone
11 13 Sep 07 nicklas 37      * @param zone The zone to add.
11 13 Sep 07 nicklas 38      */
11 13 Sep 07 nicklas 39     public void addZone(BackgroundZoneType zone) { zones.add(zone); }
11 13 Sep 07 nicklas 40     
11 13 Sep 07 nicklas 41     /** Gets a zone by index.
11 13 Sep 07 nicklas 42      * @param index The zero based index to the zone of interest.
11 13 Sep 07 nicklas 43      * @return The zone.
11 13 Sep 07 nicklas 44      */
11 13 Sep 07 nicklas 45     public BackgroundZoneType getZone(int index) { return (BackgroundZoneType) zones.elementAt(index); }
11 13 Sep 07 nicklas 46
11 13 Sep 07 nicklas 47     /** The smoothing factor used to calculate the background values. */
11 13 Sep 07 nicklas 48     private float smoothFactor;
11 13 Sep 07 nicklas 49     
11 13 Sep 07 nicklas 50     /** Gets the smoothing factor.
11 13 Sep 07 nicklas 51      * @return The smoothing factor.
11 13 Sep 07 nicklas 52      */
11 13 Sep 07 nicklas 53     public float getSmoothFactor() { return smoothFactor; }
11 13 Sep 07 nicklas 54     
11 13 Sep 07 nicklas 55     /** Sets the smoothing factor.
11 13 Sep 07 nicklas 56      * @param sf The smoothing factor.
11 13 Sep 07 nicklas 57      */
11 13 Sep 07 nicklas 58     public void setSmoothFactor(float sf) { smoothFactor = sf; }
11 13 Sep 07 nicklas 59     
11 13 Sep 07 nicklas 60     /** Creates a new instance of BackgroundZoneInfo */
11 13 Sep 07 nicklas 61     public BackgroundZoneInfo() {
11 13 Sep 07 nicklas 62         zones = new Vector();
11 13 Sep 07 nicklas 63         smoothFactor = 0.0f;
11 13 Sep 07 nicklas 64     }
11 13 Sep 07 nicklas 65     
11 13 Sep 07 nicklas 66     /** Clears the members. */
11 13 Sep 07 nicklas 67     public void clear()
11 13 Sep 07 nicklas 68     {
11 13 Sep 07 nicklas 69         smoothFactor = 0.0f;
11 13 Sep 07 nicklas 70         zones.clear();
11 13 Sep 07 nicklas 71     }
11 13 Sep 07 nicklas 72 }