Class: Bioroebe::ElectronMicroscopy::SimpleStarFileGenerator

Inherits:
CommandlineApplication show all
Includes:
Bioroebe::ElectronMicroscopy
Defined in:
lib/bioroebe/electron_microscopy/simple_star_file_generator.rb

Overview

Bioroebe::ElectronMicroscopy::SimpleStarFileGenerator

Constant Summary collapse

SAVE_HERE =
#

SAVE_HERE

#
'micrographs.star'
BASE_DIRECTORY_TO_USE =
#

BASE_DIRECTORY_TO_USE

#
''
HEADER =
#

HEADER

This the header of the mini .star file.

#
'data_images

loop_
_rlnMicrographName #1'+N

Constants included from Bioroebe::ElectronMicroscopy

DEFAULT_XMIPP_HEADER

Constants inherited from CommandlineApplication

CommandlineApplication::OLD_VERBOSE_VALUE

Constants included from ColoursForBase

ColoursForBase::ARRAY_HTML_COLOURS_IN_USE

Constants inherited from Base

Base::NAMESPACE

Instance Method Summary collapse

Methods inherited from CommandlineApplication

#all_aminoacids?, #append_what_into, #at_home?, #be_silent, #be_verbose?, #cat, #ccliner, #change_directory, #cliner, #codon_table_dataset?, #codon_to_aminoacid, #codons_for?, #colourize_this_dna_sequence, #complement, #cp, #disable_warnings, #download_dir?, #editor?, #enable_warnings, #ensure_that_the_base_directories_exist, #esystem, #extract, #is_this_a_start_codon?, #is_this_a_stop_codon?, #leading_five_prime, #load_bioroebe_yaml_file, #log_directory?, #one_letter_to_long_name, #one_to_three, #only_numbers?, #open_in_browser, #opne, #opnn, #pad_with_double_quotes, #pad_with_single_quotes, #partner_nucleotide, #remove_numbers, #remove_trailing_ansii_escape_code, #return_all_possible_start_codons, #return_array_of_one_letter_aminoacids, #return_cheerful_person, #return_chunked_display, #return_ubiquitin_sequence, #set_be_verbose, #start_codon?, #stop_codons?, #strict_filter_away_invalid_aminoacids, #taxonomy_download_directory?, #three_to_one, #to_rna, #trailing_three_prime, #use_opn?, #verbose_truth, #was_or_were, #without_extname, #write_what_into

Methods included from CommandlineArguments

#commandline_arguments?, #commandline_arguments_that_are_files?, #e, #first?, #first_non_hyphen_argument?, #remove_hyphens_from_the_commandline_arguments, #return_commandline_arguments_as_string, #return_commandline_arguments_that_are_not_files, #return_entries_without_two_leading_hyphens, #select_commandline_arguments, #select_entries_starting_with_two_hyphens, #set_commandline_arguments

Methods included from ColoursForBase

#colourize_this_aminoacid_sequence_for_the_commandline, #colourize_this_nucleotide_sequence, #disable_colours, #ecomment, #efancy, #egold, #enable_colours, #eorange, #eparse, #erev, #red, #remove_trailing_escape_part, #return_colour_for_nucleotides, #rev, #sdir, #set_use_colours, #sfancy, #sfile, #simp, #swarn, #use_colours?, #use_colours_within_the_bioroebe_namespace?

Methods inherited from Base

#append_what_into, #can_base_pair?, #convert_global_env, #delete_file, #directory_to_the_codon_tables?, #file_readlines, #infer_the_namespace, #is_on_roebe?, #is_palindrome?, #main_encoding?, #mkdir, #move_file, #mv, #namespace?, #no_file_exists_at, #no_newlines, #project_yaml_directory?, #rds, #register_sigint, #return_pwd, #return_the_first_line_of_this_file, #word_wrap, #write_what_into

Constructor Details

#initialize(optional_save_here = nil, run_already = true) ⇒ SimpleStarFileGenerator

#

initialize

#

51
52
53
54
55
56
57
58
59
60
 
# File 'lib/bioroebe/electron_microscopy/simple_star_file_generator.rb', line 51

def initialize(
    optional_save_here = nil,
    run_already        = true
  )
  reset # First reset everything.
  if optional_save_here
    set_save_here(optional_save_here)
  end
  run if run_already
end

Instance Method Details

#reset ⇒ Object

#

reset (reset tag)

#

65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/bioroebe/electron_microscopy/simple_star_file_generator.rb', line 65

def reset
  super()
  infer_the_namespace
  # ======================================================================= #
  # === @save_here
  # ======================================================================= #
  @save_here = SAVE_HERE
  # ======================================================================= #
  # === @_
  # ======================================================================= #
  @_ = HEADER.dup # @_ is the main variable.
  # ======================================================================= #
  # From which base directory to get input.
  # ======================================================================= #
  sorted = Dir[BASE_DIRECTORY_TO_USE+'*.mrc'].sort
  sorted = sorted.sort_by {|entry|
    entry =~ /_(\d+)\.mrc/ 
    $1.to_s.dup.to_i
  }
  sorted.each {|entry|
    @_ << entry+N
  }
  e @_
end

#run ⇒ Object

#

run

#

118
119
120
 
# File 'lib/bioroebe/electron_microscopy/simple_star_file_generator.rb', line 118

def run
  save_dataset
end

#save_dataset ⇒ Object

#

save_dataset

#

109
110
111
112
113
 
# File 'lib/bioroebe/electron_microscopy/simple_star_file_generator.rb', line 109

def save_dataset
  _ = save_where?
  opnn; e "Next saving the dataset into the file `#{sfile(_)}`."
  write_what_into(@_, _)
end

#save_where? ⇒ Boolean

#

save_where?

#

Returns:

  • (Boolean) 

102
103
104
 
# File 'lib/bioroebe/electron_microscopy/simple_star_file_generator.rb', line 102

def save_where?
  @save_here
end

#set_save_here(i = nil) ⇒ Object

#

set_save_here

#

93
94
95
96
97
 
# File 'lib/bioroebe/electron_microscopy/simple_star_file_generator.rb', line 93

def set_save_here(i = nil)
  i = i.first if i.is_a? Array
  i = SAVE_HERE if i.nil?
  @save_here = i
end