mev-4.0.01/source/org/tigr/microarray/mev/ISlideData.java

Code
Comments
Other
Rev Date Author Line
2 26 Feb 07 jari 1 /*
2 26 Feb 07 jari 2 Copyright @ 1999-2003, The Institute for Genomic Research (TIGR).
2 26 Feb 07 jari 3 All rights reserved.
2 26 Feb 07 jari 4  */
2 26 Feb 07 jari 5 /*
2 26 Feb 07 jari 6  * $RCSfile: ISlideData.java,v $
2 26 Feb 07 jari 7  * $Revision: 1.8 $
2 26 Feb 07 jari 8  * $Date: 2006/05/02 16:56:56 $
2 26 Feb 07 jari 9  * $Author: eleanorahowe $
2 26 Feb 07 jari 10  * $State: Exp $
2 26 Feb 07 jari 11  */
2 26 Feb 07 jari 12 package org.tigr.microarray.mev;
2 26 Feb 07 jari 13
2 26 Feb 07 jari 14 import java.io.DataInputStream;
2 26 Feb 07 jari 15 import java.io.DataOutputStream;
2 26 Feb 07 jari 16 import java.io.IOException;
2 26 Feb 07 jari 17 import java.util.Hashtable;
2 26 Feb 07 jari 18 import java.util.Properties;
2 26 Feb 07 jari 19 import java.util.Vector;
2 26 Feb 07 jari 20
2 26 Feb 07 jari 21 public interface ISlideData {
2 26 Feb 07 jari 22     
2 26 Feb 07 jari 23     // Normalization Modes
2 26 Feb 07 jari 24     public final static int NO_NORMALIZATION = 0;
2 26 Feb 07 jari 25     public final static int TOTAL_INTENSITY = 1;
2 26 Feb 07 jari 26     public final static int LEAST_SQUARES = 2;
2 26 Feb 07 jari 27     public final static int LINEAR_REGRESSION = 3;
2 26 Feb 07 jari 28     public final static int RATIO_STATISTICS_95 = 4;
2 26 Feb 07 jari 29     public final static int RATIO_STATISTICS_99 = 5;
2 26 Feb 07 jari 30     public final static int ITERATIVE_LOG = 6;
2 26 Feb 07 jari 31     public final static int LOWESS = 7;
2 26 Feb 07 jari 32     
2 26 Feb 07 jari 33     public final static int TOTAL_INTENSITY_LIST = 101;
2 26 Feb 07 jari 34     public final static int LEAST_SQUARES_LIST = 102;
2 26 Feb 07 jari 35     public final static int LINEAR_REGRESSION_LIST = 103;
2 26 Feb 07 jari 36     public final static int RATIO_STATISTICS_95_LIST = 104;
2 26 Feb 07 jari 37     public final static int RATIO_STATISTICS_99_LIST = 105;
2 26 Feb 07 jari 38     public final static int ITERATIVE_LOG_LIST = 106;
2 26 Feb 07 jari 39     public final static int LOWESS_LIST = 107;
2 26 Feb 07 jari 40     /**
2 26 Feb 07 jari 41      * CGH Constants
2 26 Feb 07 jari 42      */
2 26 Feb 07 jari 43     public static final int CY3_SLIDES = 0;
2 26 Feb 07 jari 44     public static final int CY5_SLIDES = 1;
2 26 Feb 07 jari 45     
2 26 Feb 07 jari 46     /**
2 26 Feb 07 jari 47      * Returns the name of a microarray.
2 26 Feb 07 jari 48      */
2 26 Feb 07 jari 49     public String getSlideDataName();
2 26 Feb 07 jari 50     
2 26 Feb 07 jari 51     /**
2 26 Feb 07 jari 52      * Sets a microarray name.
2 26 Feb 07 jari 53      */
2 26 Feb 07 jari 54     public void setSlideDataName(String slideDataName);
2 26 Feb 07 jari 55     
2 26 Feb 07 jari 56     /**
2 26 Feb 07 jari 57      * Sets the current label index.
2 26 Feb 07 jari 58      */
2 26 Feb 07 jari 59
2 26 Feb 07 jari 60     //TODO may need to add a method signature for adding more than one key at once
2 26 Feb 07 jari 61     /*
2 26 Feb 07 jari 62     public void setDataLabelKeys(Vector key);
2 26 Feb 07 jari 63   */
2 26 Feb 07 jari 64     
2 26 Feb 07 jari 65     //TODO may need to disable this method.
2 26 Feb 07 jari 66     /**
2 26 Feb 07 jari 67      * Sets the current label index.
2 26 Feb 07 jari 68      */
2 26 Feb 07 jari 69     public void setDataLabelKey(String key);
2 26 Feb 07 jari 70     
2 26 Feb 07 jari 71     /**
2 26 Feb 07 jari 72      * Adds a new key and label value
2 26 Feb 07 jari 73      */
2 26 Feb 07 jari 74     public void addNewSampleLabel(String label, String value);
2 26 Feb 07 jari 75     
2 26 Feb 07 jari 76     /**
2 26 Feb 07 jari 77      * Returns the slide name keys.
2 26 Feb 07 jari 78      */
2 26 Feb 07 jari 79     public Vector getSlideDataKeys();
2 26 Feb 07 jari 80  
2 26 Feb 07 jari 81     /**
2 26 Feb 07 jari 82      * Returns the slide data labels hash
2 26 Feb 07 jari 83      */
2 26 Feb 07 jari 84     public Hashtable getSlideDataLabels();
2 26 Feb 07 jari 85     
2 26 Feb 07 jari 86     /**
2 26 Feb 07 jari 87      * Sets the slide data label hash
2 26 Feb 07 jari 88      */
2 26 Feb 07 jari 89     public void setSlideDataLabels(Vector keys, Hashtable labels);
2 26 Feb 07 jari 90     
2 26 Feb 07 jari 91     /**
2 26 Feb 07 jari 92      * Returns size of a microarray.
2 26 Feb 07 jari 93      */
2 26 Feb 07 jari 94     public int getSize();
2 26 Feb 07 jari 95     
2 26 Feb 07 jari 96     /**
2 26 Feb 07 jari 97      * Returns a microarray normalization state.
2 26 Feb 07 jari 98      */
2 26 Feb 07 jari 99     public int getNormalizedState();
2 26 Feb 07 jari 100     
2 26 Feb 07 jari 101     /**
2 26 Feb 07 jari 102      * Sets a microarray normalization state.
2 26 Feb 07 jari 103      */
2 26 Feb 07 jari 104     public void setNormalizedState(int normalizedState);
2 26 Feb 07 jari 105     
2 26 Feb 07 jari 106     /**
2 26 Feb 07 jari 107      * Returns a microarray sort state.
2 26 Feb 07 jari 108      */
2 26 Feb 07 jari 109     public int getSortState();
2 26 Feb 07 jari 110     
2 26 Feb 07 jari 111     /**
2 26 Feb 07 jari 112      * Returns CY3 value for specified index.
2 26 Feb 07 jari 113      */
2 26 Feb 07 jari 114     public float getCY3(int index);
2 26 Feb 07 jari 115     
2 26 Feb 07 jari 116     /**
2 26 Feb 07 jari 117      * Returns CY5 value for specified index.
2 26 Feb 07 jari 118      */
2 26 Feb 07 jari 119     public float getCY5(int index);
2 26 Feb 07 jari 120     
2 26 Feb 07 jari 121     /**
2 26 Feb 07 jari 122      * Returns a microarray max CY3 value.
2 26 Feb 07 jari 123      */
2 26 Feb 07 jari 124     public float getMaxCY3();
2 26 Feb 07 jari 125     
2 26 Feb 07 jari 126     /**
2 26 Feb 07 jari 127      * Returns a microarray max CY5 value.
2 26 Feb 07 jari 128      */
2 26 Feb 07 jari 129     public float getMaxCY5();
2 26 Feb 07 jari 130     
2 26 Feb 07 jari 131     /**
2 26 Feb 07 jari 132      * Returns max intencity of specified type.
2 26 Feb 07 jari 133      */
2 26 Feb 07 jari 134     public float getMaxIntensity(int intensityType);
2 26 Feb 07 jari 135     
2 26 Feb 07 jari 136     /**
2 26 Feb 07 jari 137      * Returns min intencity of specified type.
2 26 Feb 07 jari 138      */
2 26 Feb 07 jari 139     public float getMinIntensity(int intensityType, boolean acceptZeros);
2 26 Feb 07 jari 140     
2 26 Feb 07 jari 141     /**
2 26 Feb 07 jari 142      * Returns a ratio value with specified index and log state.
2 26 Feb 07 jari 143      */
2 26 Feb 07 jari 144     public float getRatio(int index, int logState);
2 26 Feb 07 jari 145     
2 26 Feb 07 jari 146     /**
2 26 Feb 07 jari 147      * Returns a microarray max ratio value.
2 26 Feb 07 jari 148      */
2 26 Feb 07 jari 149     public float getMaxRatio();
2 26 Feb 07 jari 150     
2 26 Feb 07 jari 151     /**
2 26 Feb 07 jari 152      * Returns a microarray max ratio value, with specified log state.
2 26 Feb 07 jari 153      */
2 26 Feb 07 jari 154     public float getMaxRatio(int logState);
2 26 Feb 07 jari 155     
2 26 Feb 07 jari 156     /**
2 26 Feb 07 jari 157      * Returns a microarray max ratio value of specified intensities.
2 26 Feb 07 jari 158      */
2 26 Feb 07 jari 159     public float getMaxRatio(int intensityIndex1, int intensityIndex2, int logState);
2 26 Feb 07 jari 160     
2 26 Feb 07 jari 161     /**
2 26 Feb 07 jari 162      * Returns a microarray min ratio value.
2 26 Feb 07 jari 163      */
2 26 Feb 07 jari 164     public float getMinRatio();
2 26 Feb 07 jari 165     
2 26 Feb 07 jari 166     /**
2 26 Feb 07 jari 167      * Returns a microarray min ratio value with specified log state.
2 26 Feb 07 jari 168      */
2 26 Feb 07 jari 169     public float getMinRatio(int logState);
2 26 Feb 07 jari 170     
2 26 Feb 07 jari 171     /**
2 26 Feb 07 jari 172      * Returns a microarray min ratio value of specified intensities.
2 26 Feb 07 jari 173      */
2 26 Feb 07 jari 174     public float getMinRatio(int intensityIndex1, int intensityIndex2, int logState);
2 26 Feb 07 jari 175     
2 26 Feb 07 jari 176     /**
2 26 Feb 07 jari 177      * Returns a microarray max product value of specified intensities.
2 26 Feb 07 jari 178      */
2 26 Feb 07 jari 179     public float getMaxProduct(int intensityIndex1, int intensityIndex2);
2 26 Feb 07 jari 180     
2 26 Feb 07 jari 181     /**
2 26 Feb 07 jari 182      * Returns a microarray min product value of specified intensities.
2 26 Feb 07 jari 183      */
2 26 Feb 07 jari 184     public float getMinProduct(int intensityIndex1, int intensityIndex2, boolean acceptZeros);
2 26 Feb 07 jari 185     
2 26 Feb 07 jari 186     /**
2 26 Feb 07 jari 187      * Returns a microarray min product value of specified intensities and lower cutoffs.
2 26 Feb 07 jari 188      */
2 26 Feb 07 jari 189     public float getMinProduct(int intensityIndex1, int intensityIndex2, boolean acceptZeros, int lowCutoff);
2 26 Feb 07 jari 190     
2 26 Feb 07 jari 191     /**
2 26 Feb 07 jari 192      * Normalizes a microarray data.
2 26 Feb 07 jari 193      */
2 26 Feb 07 jari 194     public void applyNormalization(int normalizationMode, Properties properties);
2 26 Feb 07 jari 195     
2 26 Feb 07 jari 196     /**
2 26 Feb 07 jari 197      * Normalizes a microarray data.
2 26 Feb 07 jari 198      */
2 26 Feb 07 jari 199     public void applyNormalizationList(int normalizationMode);
2 26 Feb 07 jari 200     
2 26 Feb 07 jari 201     /**
2 26 Feb 07 jari 202      * Sets a microarray non-zero attribute.
2 26 Feb 07 jari 203      */
2 26 Feb 07 jari 204     public void setNonZero(boolean value);
2 26 Feb 07 jari 205     
2 26 Feb 07 jari 206     /**
2 26 Feb 07 jari 207      * Sets intensities for a spot with specified index.
2 26 Feb 07 jari 208      */
2 26 Feb 07 jari 209     public void setIntensities(int index, float cy3, float cy5);
2 26 Feb 07 jari 210     
2 26 Feb 07 jari 211     /**
2 26 Feb 07 jari 212      * Returns an <code>ISlideDataElement</code> by specified index.
2 26 Feb 07 jari 213      */
2 26 Feb 07 jari 214     public ISlideDataElement getSlideDataElement(int index);
2 26 Feb 07 jari 215     
2 26 Feb 07 jari 216     /**
2 26 Feb 07 jari 217      * Adds an <code>ISlideDataElement</code> to a microarray.
2 26 Feb 07 jari 218      */
2 26 Feb 07 jari 219     public void addSlideDataElement(ISlideDataElement element);
2 26 Feb 07 jari 220     
2 26 Feb 07 jari 221     /**
2 26 Feb 07 jari 222      * Returns a reference to a microarray meta data.
2 26 Feb 07 jari 223      */
2 26 Feb 07 jari 224     public ISlideMetaData getSlideMetaData();
2 26 Feb 07 jari 225     
2 26 Feb 07 jari 226     /**
2 26 Feb 07 jari 227      * Sets spot specific data such as spot area, QC scores, saturation factors, etc.
2 26 Feb 07 jari 228      */
2 26 Feb 07 jari 229     public void setSpotInformationData(String [] infoLabels, String [][] spotData);
2 26 Feb 07 jari 230     
2 26 Feb 07 jari 231     /**
2 26 Feb 07 jari 232      * Returns the <code>SpotInformationData</code> object.
2 26 Feb 07 jari 233      */
2 26 Feb 07 jari 234     public SpotInformationData getSpotInformationData();
2 26 Feb 07 jari 235     
2 26 Feb 07 jari 236     /**
2 26 Feb 07 jari 237      * Toggles the length of the displayed file name.
2 26 Feb 07 jari 238      */
2 26 Feb 07 jari 239     public void toggleNameLength();
2 26 Feb 07 jari 240     
2 26 Feb 07 jari 241     /**
2 26 Feb 07 jari 242      * Returns the full name (not truncated)
2 26 Feb 07 jari 243      */
2 26 Feb 07 jari 244     public String getFullSlideDataName();
2 26 Feb 07 jari 245     
2 26 Feb 07 jari 246     /**
2 26 Feb 07 jari 247      * Sets the data type attribute see static type variables in <code>IData</code>
2 26 Feb 07 jari 248      */
2 26 Feb 07 jari 249     public void setDataType(int type);
2 26 Feb 07 jari 250       
2 26 Feb 07 jari 251     /**
2 26 Feb 07 jari 252      * Returns the data type attribute
2 26 Feb 07 jari 253      */
2 26 Feb 07 jari 254     public int getDataType();
2 26 Feb 07 jari 255     
2 26 Feb 07 jari 256     /**
2 26 Feb 07 jari 257      * Sets the slide file name
2 26 Feb 07 jari 258      */
2 26 Feb 07 jari 259     public void setSlideFileName(String fileName);
2 26 Feb 07 jari 260     
2 26 Feb 07 jari 261     /**
2 26 Feb 07 jari 262      * Writes float values of intensities for this slide to an output stream.
2 26 Feb 07 jari 263      * @param dos output stream to write to
2 26 Feb 07 jari 264      */
2 26 Feb 07 jari 265     //public void writeIntensities(DataOutputStream dos) throws IOException;
2 26 Feb 07 jari 266     //public void loadIntensities(DataInputStream dis) throws IOException;
2 26 Feb 07 jari 267     /**
2 26 Feb 07 jari 268      * Returns the slide's file name
2 26 Feb 07 jari 269      */
2 26 Feb 07 jari 270     public String getSlideFileName();
2 26 Feb 07 jari 271     
2 26 Feb 07 jari 272     /**
2 26 Feb 07 jari 273      * Returns the detection status for the gene specified, Affy support
2 26 Feb 07 jari 274      */
2 26 Feb 07 jari 275
2 26 Feb 07 jari 276     public String getDetection(int row);
2 26 Feb 07 jari 277     //add by wwang
2 26 Feb 07 jari 278     public float getPvalue(int row);
2 26 Feb 07 jari 279     public int getGenePixFlags(int row);
2 26 Feb 07 jari 280
2 26 Feb 07 jari 281    
2 26 Feb 07 jari 282     /**
2 26 Feb 07 jari 283      * CGH Function from ICGHFeatureData
2 26 Feb 07 jari 284      * @param flankingRegions
2 26 Feb 07 jari 285      */
2 26 Feb 07 jari 286     public void setFlankingRegions(java.util.Vector[] flankingRegions);
2 26 Feb 07 jari 287     /**
2 26 Feb 07 jari 288      * CGH Function from ICGHFeatureData
2 26 Feb 07 jari 289      * @param chromosomeIndex
2 26 Feb 07 jari 290      * @return
2 26 Feb 07 jari 291      */
2 26 Feb 07 jari 292     public int getNumFlankingRegions(int chromosomeIndex);
2 26 Feb 07 jari 293     /**
2 26 Feb 07 jari 294      * CGH Function from ICGHFeatureData
2 26 Feb 07 jari 295      * @return
2 26 Feb 07 jari 296      */
2 26 Feb 07 jari 297     public java.util.Vector[] getFlankingRegions();
2 26 Feb 07 jari 298     /**
2 26 Feb 07 jari 299      * CGH Function from ICGHFeatureData
2 26 Feb 07 jari 300      * @param cloneIndex
2 26 Feb 07 jari 301      * @return
2 26 Feb 07 jari 302      */
2 26 Feb 07 jari 303     public boolean isMissingData(int cloneIndex);
2 26 Feb 07 jari 304     
2 26 Feb 07 jari 305     public String getSampleLabelKey();
2 26 Feb 07 jari 306
2 26 Feb 07 jari 307 }

Generated on Thu Jul 20 09:30:54 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)