Class: AsposeImagingCloud::DeconvolutionFilterProperties

Inherits:
Object
  • Object
show all
Defined in:
lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb

Overview

Deconvolution Filter Options, abstract class

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeconvolutionFilterProperties

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 70

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'discriminator')
    self.discriminator = attributes[:'discriminator']
  end

  if attributes.has_key?(:'Snr')
    self.snr = attributes[:'Snr']
  end

  if attributes.has_key?(:'Brightness')
    self.brightness = attributes[:'Brightness']
  end

  if attributes.has_key?(:'Grayscale')
    self.grayscale = attributes[:'Grayscale']
  end

  if attributes.has_key?(:'IsPartialLoaded')
    self.is_partial_loaded = attributes[:'IsPartialLoaded']
  end
end

Instance Attribute Details

#brightness ⇒ Object

Gets or sets the brightness. recommended range 1 - 1.5 default value = 1.15



38
39
40
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 38

def brightness
  @brightness
end

#discriminator ⇒ Object

Returns the value of attribute discriminator.



32
33
34
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 32

def discriminator
  @discriminator
end

#grayscale ⇒ Object

Gets or sets a value indicating whether this DeconvolutionFilterProperties is grayscale. Return grayscale mode or RGB mode.



41
42
43
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 41

def grayscale
  @grayscale
end

#is_partial_loaded ⇒ Object

Gets a value indicating whether this instance is partial loaded.



44
45
46
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 44

def is_partial_loaded
  @is_partial_loaded
end

#snr ⇒ Object

Gets or sets the SNR(signal-to-noise ratio) recommended range 0.002 - 0.009, default value = 0.007



35
36
37
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 35

def snr
  @snr
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



47
48
49
50
51
52
53
54
55
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 47

def self.attribute_map
  {
    :'discriminator' => :'discriminator',
    :'snr' => :'Snr',
    :'brightness' => :'Brightness',
    :'grayscale' => :'Grayscale',
    :'is_partial_loaded' => :'IsPartialLoaded'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 58

def self.swagger_types
  {
    :'discriminator' => :'String',
    :'snr' => :'Float',
    :'brightness' => :'Float',
    :'grayscale' => :'BOOLEAN',
    :'is_partial_loaded' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



137
138
139
140
141
142
143
144
145
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 137

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      discriminator == o.discriminator &&
      snr == o.snr &&
      brightness == o.brightness &&
      grayscale == o.grayscale &&
      is_partial_loaded == o.is_partial_loaded
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 185

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = AsposeImagingCloud.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 251

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 162

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    attribute_key = self.class.attribute_map[key]
    attribute_key = (attribute_key[0, 1].downcase + attribute_key[1..-1]).to_sym
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[attribute_key].is_a?(Array)
        self.send("#{key}=", attributes[attribute_key].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[attribute_key].nil?
      self.send("#{key}=", _deserialize(type, attributes[attribute_key]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


149
150
151
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 149

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



155
156
157
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 155

def hash
  [discriminator, snr, brightness, grayscale, is_partial_loaded].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 99

def list_invalid_properties
  invalid_properties = Array.new
  if @discriminator.nil?
    invalid_properties.push('invalid value for "discriminator", discriminator cannot be nil.')
  end

  if @snr.nil?
    invalid_properties.push('invalid value for "snr", snr cannot be nil.')
  end

  if @brightness.nil?
    invalid_properties.push('invalid value for "brightness", brightness cannot be nil.')
  end

  if @grayscale.nil?
    invalid_properties.push('invalid value for "grayscale", grayscale cannot be nil.')
  end

  if @is_partial_loaded.nil?
    invalid_properties.push('invalid value for "is_partial_loaded", is_partial_loaded cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 231

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
240
241
242
243
244
245
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 237

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



225
226
227
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 225

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



126
127
128
129
130
131
132
133
 
# File 'lib/aspose-imaging-cloud/models/deconvolution_filter_properties.rb', line 126

def valid?
  return false if @discriminator.nil?
  return false if @snr.nil?
  return false if @brightness.nil?
  return false if @grayscale.nil?
  return false if @is_partial_loaded.nil?
  true
end