| 1 | package Microarray::File::Data::Agilent; | ||
| 2 | |||
| 3 | use 5.006; | ||
| 4 | use strict; | ||
| 5 | use warnings; | ||
| 6 | our $VERSION = '2.2'; | ||
| 7 | |||
| 8 | sub auto_data_file { | ||
| 9 | 'agilent_file','agilent'; | ||
| 10 | } | ||
| 11 | |||
| 12 | { package agilent_file; | ||
| 13 | |||
| 14 | require Microarray::File::Data; | ||
| 15 | |||
| 16 | our @ISA = qw( data_file ); | ||
| 17 | |||
| 18 | # setter for { _spot_data }, { _data_fields } and { _header_info } | ||
| 19 | sub sort_data { | ||
| 20 | my $self = shift; | ||
| 21 | my $aaData = shift; | ||
| 22 | $self->set_header_info($aaData); | ||
| 23 | $self->{ _spot_data } = $aaData; # all the numbers | ||
| 24 | $self->{ _spot_count } = scalar @$aaData; | ||
| 25 | } | ||
| 26 | # information about the scan | ||
| 27 | sub set_header_info { | ||
| 28 | my $self = shift; | ||
| 29 | my $aaData = shift; | ||
| 30 | my $hHeader_Info = { }; | ||
| 31 | my $hFeparams_Info = { }; | ||
| 32 | my $hStats_Info = { }; | ||
| 33 | my $which_info; | ||
| 34 | ROW:while (my $aRow = shift @$aaData){ | ||
| 35 | next ROW if (($$aRow[0] eq 'TYPE')||($$aRow[0] eq '*')); | ||
| 36 | if ($$aRow[0] eq 'FEATURES'){ | ||
| 37 | $self->set_data_fields($aRow); | ||
| 38 | last ROW; | ||
| 39 | } elsif ($$aRow[0] eq 'FEPARAMS'){ | ||
| 40 | for (my $i=1; $i<@$aRow; $i++){ | ||
| 41 | $hFeparams_Info->{ $i } = $$aRow[$i]; | ||
| 42 | } | ||
| 43 | $which_info = 'feparams'; | ||
| 44 | next ROW; | ||
| 45 | } elsif ($$aRow[0] eq 'STATS'){ | ||
| 46 | for (my $i=1; $i<@$aRow; $i++){ | ||
| 47 | $hStats_Info->{ $i } = $$aRow[$i]; | ||
| 48 | } | ||
| 49 | $which_info = 'stats'; | ||
| 50 | next ROW; | ||
| 51 | } elsif ($$aRow[0] eq 'DATA'){ | ||
| 52 | if ($which_info eq 'stats'){ | ||
| 53 | for (my $i=1; $i<@$aRow; $i++){ | ||
| 54 | $hHeader_Info->{ $hStats_Info->{ $i } } = $$aRow[$i]; | ||
| 55 | } | ||
| 56 | } else { | ||
| 57 | for (my $i=1; $i<@$aRow; $i++){ | ||
| 58 | $hHeader_Info->{ $hFeparams_Info->{ $i } } = $$aRow[$i]; | ||
| 59 | } | ||
| 60 | } | ||
| 61 | } | ||
| 62 | } | ||
| 63 | $self->{ _header_info } = $hHeader_Info; | ||
| 64 | } | ||
| 65 | sub data_file_fields { # minimum required fields | ||
| 66 | [ 'spot_index','feature_id','synonym_id', | ||
| 67 | 'channel1_signal','channel2_signal', | ||
| 68 | 'channel1_snr','channel2_snr', | ||
| 69 | 'channel1_quality','channel2_quality', | ||
| 70 | 'channel1_sat','channel2_sat', | ||
| 71 | 'spot_pixels','flag_id', | ||
| 72 | 'spot_row','spot_col','x_pos','y_pos','bg_pixels', | ||
| 73 | 'ch1_mean_f','ch1_median_f','ch1_sd_f','ch1_mean_b', | ||
| 74 | 'ch1_median_b','ch1_sd_b','ch2_mean_f', | ||
| 75 | 'ch2_median_f','ch2_sd_f','ch2_mean_b','ch2_median_b', | ||
| 76 | 'ch2_sd_b', ]; | ||
| 77 | } | ||
| 78 | sub delimiter { | ||
| 79 | return "\t"; | ||
| 80 | } | ||
| 81 | sub pixel_size { | ||
| 82 | my $self = shift; | ||
| 83 | unless ($self->pixelx_size == $self->pixely_size){ | ||
| 84 | # worry about this if it ever becomes an issue! | ||
| 85 | } | ||
| 86 | $self->pixelx_size; | ||
| 87 | } | ||
| 88 | sub pixelx_size { | ||
| 89 | my $self = shift; | ||
| 90 | $self->get_header_info('Scan_MicronsPerPixelX'); | ||
| 91 | } | ||
| 92 | sub pixely_size { | ||
| 93 | my $self = shift; | ||
| 94 | $self->get_header_info('Scan_MicronsPerPixelY'); | ||
| 95 | } | ||
| 96 | sub channel1_name { | ||
| 97 | 'r'; | ||
| 98 | } | ||
| 99 | sub channel2_name { | ||
| 100 | 'g'; | ||
| 101 | } | ||
| 102 | sub channel_name { | ||
| 103 | my $self = shift; | ||
| 104 | my $ch = shift; | ||
| 105 | my $method = 'channel'.$ch.'_name'; | ||
| 106 | $self->$method; | ||
| 107 | } | ||
| 108 | sub num_channels { | ||
| 109 | my $self = shift; | ||
| 110 | $self->get_header_info('Scan_NumChannels'); | ||
| 111 | } | ||
| 112 | sub slide_barcode { | ||
| 113 | my $self = shift; | ||
| 114 | $self->get_header_info('FeatureExtractor_Barcode'); | ||
| 115 | } | ||
| 116 | sub gal_file { | ||
| 117 | my $self = shift; | ||
| 118 | $self->get_header_info('FeatureExtractor_DesignFileName'); | ||
| 119 | } | ||
| 120 | sub analysis_software { | ||
| 121 | 'Agilent'; | ||
| 122 | } | ||
| 123 | sub scanner { | ||
| 124 | my $self = shift; | ||
| 125 | $self->get_header_info('Scan_ScannerName'); | ||
| 126 | } | ||
| 127 | ### data file fields ### | ||
| 128 | sub spot_index { | ||
| 129 | my $self = shift; | ||
| 130 | $self->return_data(shift,$self->get_column_id('FeatureNum')); | ||
| 131 | } | ||
| 132 | sub spot_row { | ||
| 133 | my $self = shift; | ||
| 134 | $self->return_data(shift,$self->get_column_id('Row')); | ||
| 135 | } | ||
| 136 | sub spot_col { | ||
| 137 | my $self = shift; | ||
| 138 | $self->return_data(shift,$self->get_column_id('Col')); | ||
| 139 | } | ||
| 140 | sub x_pos { | ||
| 141 | my $self = shift; | ||
| 142 | $self->return_data(shift,$self->get_column_id('PositionX')); | ||
| 143 | } | ||
| 144 | sub y_pos { | ||
| 145 | my $self = shift; | ||
| 146 | $self->return_data(shift,$self->get_column_id('PositionY')); | ||
| 147 | } | ||
| 148 | sub feature_id { | ||
| 149 | my $self = shift; | ||
| 150 | $self->return_data(shift,$self->get_column_id('GeneName')); | ||
| 151 | } | ||
| 152 | sub synonym_id { | ||
| 153 | my $self = shift; | ||
| 154 | $self->return_data(shift,$self->get_column_id('SystematicName')); | ||
| 155 | } | ||
| 156 | sub ch1_spot_pixels { | ||
| 157 | my $self = shift; | ||
| 158 | $self->return_data(shift,$self->get_column_id('rNumPix')); | ||
| 159 | } | ||
| 160 | sub ch2_spot_pixels { | ||
| 161 | my $self = shift; | ||
| 162 | $self->return_data(shift,$self->get_column_id('gNumPix')); | ||
| 163 | } | ||
| 164 | sub spot_pixels { | ||
| 165 | my $self = shift; | ||
| 166 | my $index = shift; | ||
| 167 | my $ch1_pix = $self->ch1_spot_pixels($index); | ||
| 168 | my $ch2_pix = $self->ch2_spot_pixels($index); | ||
| 169 | if ($ch2_pix > $ch1_pix){ | ||
| 170 | return $ch2_pix; | ||
| 171 | } else { | ||
| 172 | return $ch1_pix; | ||
| 173 | } | ||
| 174 | } | ||
| 175 | sub ch1_bg_pixels { | ||
| 176 | my $self = shift; | ||
| 177 | $self->return_data(shift,$self->get_column_id('rBGNumPix')); | ||
| 178 | } | ||
| 179 | sub ch2_bg_pixels { | ||
| 180 | my $self = shift; | ||
| 181 | $self->return_data(shift,$self->get_column_id('gBGNumPix')); | ||
| 182 | } | ||
| 183 | sub bg_pixels { | ||
| 184 | my $self = shift; | ||
| 185 | my $index = shift; | ||
| 186 | my $ch1_pix = $self->ch1_bg_pixels($index); | ||
| 187 | my $ch2_pix = $self->ch2_bg_pixels($index); | ||
| 188 | if ($ch2_pix > $ch1_pix){ | ||
| 189 | return $ch2_pix; | ||
| 190 | } else { | ||
| 191 | return $ch1_pix; | ||
| 192 | } | ||
| 193 | } | ||
| 194 | sub flag_id { | ||
| 195 | my $self = shift; | ||
| 196 | $self->return_data(shift,$self->get_column_id('IsManualFlag')); | ||
| 197 | } | ||
| 198 | sub ch1_mean_f { | ||
| 199 | my $self = shift; | ||
| 200 | $self->return_data(shift,$self->get_column_id('rMeanSignal')); | ||
| 201 | } | ||
| 202 | sub ch1_median_f { | ||
| 203 | my $self = shift; | ||
| 204 | $self->return_data(shift,$self->get_column_id('rMedianSignal')); | ||
| 205 | } | ||
| 206 | sub ch1_sd_f { | ||
| 207 | my $self = shift; | ||
| 208 | $self->return_data(shift,$self->get_column_id('rPixSDev')); | ||
| 209 | } | ||
| 210 | sub ch1_mean_b { | ||
| 211 | my $self = shift; | ||
| 212 | $self->return_data(shift,$self->get_column_id('rBGMeanSignal')); | ||
| 213 | } | ||
| 214 | sub ch1_median_b { | ||
| 215 | my $self = shift; | ||
| 216 | $self->return_data(shift,$self->get_column_id('rBGMedianSignal')); | ||
| 217 | } | ||
| 218 | sub ch1_sd_b { | ||
| 219 | my $self = shift; | ||
| 220 | $self->return_data(shift,$self->get_column_id('rBGPixSDev')); | ||
| 221 | } | ||
| 222 | sub channel1_quality { | ||
| 223 | my $self = shift; | ||
| 224 | $self->return_data(shift,$self->get_column_id('rPValFeatEqBG')); | ||
| 225 | } | ||
| 226 | sub channel1_sat { | ||
| 227 | my $self = shift; | ||
| 228 | my $index = shift; | ||
| 229 | my $num_pix = $self->ch1_spot_pixels($index); | ||
| 230 | my $num_sat_pix = $self->channel1_sat_pix($index); | ||
| 231 | return ($num_sat_pix/$num_pix) * 100; | ||
| 232 | } | ||
| 233 | sub channel1_sat_pix { | ||
| 234 | my $self = shift; | ||
| 235 | $self->return_data(shift,$self->get_column_id('rNumSatPix')); | ||
| 236 | } | ||
| 237 | sub ch2_mean_f { | ||
| 238 | my $self = shift; | ||
| 239 | $self->return_data(shift,$self->get_column_id('gMeanSignal')); | ||
| 240 | } | ||
| 241 | sub ch2_median_f { | ||
| 242 | my $self = shift; | ||
| 243 | $self->return_data(shift,$self->get_column_id('gMedianSignal')); | ||
| 244 | } | ||
| 245 | sub ch2_sd_f { | ||
| 246 | my $self = shift; | ||
| 247 | $self->return_data(shift,$self->get_column_id('gPixSDev')); | ||
| 248 | } | ||
| 249 | sub ch2_mean_b { | ||
| 250 | my $self = shift; | ||
| 251 | $self->return_data(shift,$self->get_column_id('gBGMeanSignal')); | ||
| 252 | } | ||
| 253 | sub ch2_median_b { | ||
| 254 | my $self = shift; | ||
| 255 | $self->return_data(shift,$self->get_column_id('gBGMedianSignal')); | ||
| 256 | } | ||
| 257 | sub ch2_sd_b { | ||
| 258 | my $self = shift; | ||
| 259 | $self->return_data(shift,$self->get_column_id('gBGPixSDev')); | ||
| 260 | } | ||
| 261 | sub channel2_quality { | ||
| 262 | my $self = shift; | ||
| 263 | $self->return_data(shift,$self->get_column_id('gPValFeatEqBG')); | ||
| 264 | } | ||
| 265 | sub channel2_sat { | ||
| 266 | my $self = shift; | ||
| 267 | my $index = shift; | ||
| 268 | my $num_pix = $self->ch2_spot_pixels($index); | ||
| 269 | my $num_sat_pix = $self->channel2_sat_pix($index); | ||
| 270 | return ($num_sat_pix/$num_pix) * 100; | ||
| 271 | } | ||
| 272 | sub channel2_sat_pix { | ||
| 273 | my $self = shift; | ||
| 274 | $self->return_data(shift,$self->get_column_id('gNumSatPix')); | ||
| 275 | } | ||
| 276 | |||
| 277 | ### calculated fields ### | ||
| 278 | sub channel1_signal { | ||
| 279 | my $self = shift; | ||
| 280 | $self->return_data(shift,$self->get_column_id('rProcessedSignal')); | ||
| 281 | } | ||
| 282 | sub channel2_signal { | ||
| 283 | my $self = shift; | ||
| 284 | $self->return_data(shift,$self->get_column_id('gProcessedSignal')); | ||
| 285 | } | ||
| 286 | sub channel_signal { | ||
| 287 | my $self = shift; | ||
| 288 | my $index = shift; | ||
| 289 | my $ch = shift; | ||
| 290 | my $method = 'channel'.$ch.'_signal'; | ||
| 291 | $self->$method($index); | ||
| 292 | } | ||
| 293 | ###Êis there not an SNR field we can use here instead? ### | ||
| 294 | sub channel1_snr { | ||
| 295 | my $self = shift; | ||
| 296 | my $index = shift; | ||
| 297 | my $median = $self->ch1_median_f($index); | ||
| 298 | my $sd = $self->ch1_sd_b($index); | ||
| 299 | if ($median && $sd) { | ||
| 300 | return $median / $sd; | ||
| 301 | } elsif ($median) { | ||
| 302 | return $median; | ||
| 303 | } else { | ||
| 304 | return 0; | ||
| 305 | } | ||
| 306 | } | ||
| 307 | sub channel2_snr { | ||
| 308 | my $self = shift; | ||
| 309 | my $index = shift; | ||
| 310 | my $median = $self->ch2_median_f($index); | ||
| 311 | my $sd = $self->ch2_sd_b($index); | ||
| 312 | if ($median && $sd) { | ||
| 313 | return $median / $sd; | ||
| 314 | } elsif ($median) { | ||
| 315 | return $median; | ||
| 316 | } else { | ||
| 317 | return 0; | ||
| 318 | } | ||
| 319 | } | ||
| 320 | sub channel_snr { | ||
| 321 | my $self = shift; | ||
| 322 | my $index = shift; | ||
| 323 | my $ch = shift; | ||
| 324 | my $method = 'channel'.$ch.'_snr'; | ||
| 325 | $self->$method($index); | ||
| 326 | } | ||
| 327 | sub channel_quality { | ||
| 328 | my $self = shift; | ||
| 329 | my $index = shift; | ||
| 330 | my $ch = shift; | ||
| 331 | my $method = 'channel'.$ch.'_quality'; | ||
| 332 | $self->$method($index); | ||
| 333 | } | ||
| 334 | sub channel_sat { | ||
| 335 | my $self = shift; | ||
| 336 | my $index = shift; | ||
| 337 | my $ch = shift; | ||
| 338 | my $method = 'channel'.$ch.'_sat'; | ||
| 339 | $self->$method($index); | ||
| 340 | } | ||
| 341 | sub bad_flags { | ||
| 342 | { '1'=>'1' }; | ||
| 343 | } | ||
| 344 | } | ||
| 345 | |||
| 346 | 1; | ||
| 347 | |||
| 348 | __END__ |