module FCSParse

Contains all classes and constants for parsing FCS v3.x formatted files.

Contains all classes and constants for parsing FCS v3.x formatted files.

Contains all classes and constants for parsing FCS v3.x formatted files.

Constants

H_AnalysisBlockOffsetEnd
H_AnalysisBlockOffsetStart

offsets to the start and end of the analysis section offset

H_DataBlockOffsetEnd
H_DataBlockOffsetStart

offsets to the start and end of the data section offset

H_OffsetBlockLength

length of the block specifying the offsets of text, data, analysis sections

H_TextBlockOffsetEnd
H_TextBlockOffsetStart

offsets to the start and end of the text section offset

H_VersionEnd
H_VersionStart

byte offsets to the start and end of the version string

T_AnalysisEndKeyword
T_AnalysisStartKeyword

keyword specifying offset to analysis section

T_ByteorderKeyword

keyword specifying byte order and value when little endian

T_DataEndKeyword
T_DataStartKeyword

keyword specifying offset to data section

T_DatatypeKeyword

keyword specifying the data type (e.g. integer, float, etc)

T_EventCountKeyword

keyword specifying total number of events

T_LittleEndianByteorder
T_ModeKeyword

keyword specifying the data mode

T_ParameterCountKeyword

keyword specifying the number of parameters measured per event

T_ParameterNameKeywordRegex

regular expressions matching names and ranges of all parameters

T_ParameterRangeKeywordRegex
T_SupplTextEndKeyword
T_SupplTextStartKeyword

keyword specifying offset to supplementary text section

VERSION

Public Class Methods

process_file(filename, data_header_row = true) click to toggle source

Processes a specified FCS-formatted file, and writes human-readable output to disk in the format specified by {FCSFile#write_metadata_and_data}.

@param [String] filename the filename of the FCS-encoded file (with path as required to locate it) @param [Boolean] data_header_row an optional parameter specifying whether the data file should have a header row with the name of each column’s parameter. Defaults to true.

# File lib/fcsparse.rb, line 345
def self.process_file(filename, data_header_row = true)
  
  fcsfile = FCSFile.new_from_file(filename)
  fcsfile.parse
  fcsfile.write_metadata_and_data(data_header_row)
  
  nil
  
end