Add some apidoc for rubella.rb
This commit is contained in:
parent
27b0a3dbda
commit
cdbc3ee102
|
@ -46,14 +46,29 @@ module Rubella
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Creates a heatmap in the on construction given format. The data must be
|
||||||
|
# in the also on construction given formate.
|
||||||
|
#
|
||||||
|
# @param data string The data, which should be used
|
||||||
|
# @return binaryblob An output representation of the heatmap
|
||||||
def create_from_string data
|
def create_from_string data
|
||||||
process @input.string data
|
process @input.string data
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Creates a heatmap in the on construction given format. The data must be
|
||||||
|
# in the also on construction given formate.
|
||||||
|
#
|
||||||
|
# @param file_name string
|
||||||
|
# @return binaryblob An output representation of the heatmap
|
||||||
def create_from_file file_name
|
def create_from_file file_name
|
||||||
process @input.file file_name
|
process @input.file file_name
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Processes the creation of the heatmap, after the construction of the input
|
||||||
|
# object. So the input object is given here as parameter.
|
||||||
|
#
|
||||||
|
# @param inpt Input The inputed data
|
||||||
|
# @return binaryblob An output representation of the heatmap
|
||||||
def process inpt
|
def process inpt
|
||||||
weight = @weighting.new 10
|
weight = @weighting.new 10
|
||||||
outpt = @output.new
|
outpt = @output.new
|
||||||
|
|
Loading…
Reference in New Issue