Click or drag to resize

PhotoColorCoolerCommand Class

Makes an image appear cooler by adding blue and reducing red without affecting the overall tone or contrast of the image. This is similar to correcting the White Balance setting on a digital camera. The amount of cooling is controlled using the Effect parameter.

By default the command cools by about 20% (1.2), which is the equivalent at daylight color temperatures of about 800-1000 degrees of color temperature.

Inheritance Hierarchy
SystemObject
  Atalasoft.Imaging.ImageProcessingImageCommand
    Atalasoft.Imaging.ImageProcessing.EffectsPhotoColorCorrectCommandBase
      Atalasoft.Imaging.ImageProcessing.EffectsPhotoColorCoolerCommand

Namespace:  Atalasoft.Imaging.ImageProcessing.Effects
Assembly:  Atalasoft.dotImage.AdvancedPhotoEffects (in Atalasoft.dotImage.AdvancedPhotoEffects.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class PhotoColorCoolerCommand : PhotoColorCorrectCommandBase

The PhotoColorCoolerCommand type exposes the following members.

Constructors
  NameDescription
Public methodPhotoColorCoolerCommand
Initializes a new instance of the PhotoColorCoolerCommand class.
Public methodPhotoColorCoolerCommand(Double)
Initializes a new instance of the PhotoColorCoolerCommand class with specified cool effect value.
Protected methodPhotoColorCoolerCommand(SerializationInfo, StreamingContext)
Initializes a new instance of the PhotoColorCoolerCommand class with serialized data.
Top
Properties
  NameDescription
Public propertyApplyToAnyPixelFormat
Reports whether or not this command will be applied to any supplied PixelFormat image
(Inherited from ImageCommand.)
Public propertyCanApplyToAnyPixelFormat
Returns true if the command can be applied to any PixelFormat.
(Inherited from ImageCommand.)
Public propertyEffect
Gets or sets cool effect value for the image.
Public propertyInPlaceProcessing
Gets a value indicating if the source image data is processed in-place as opposed to returning a new image.
(Inherited from PhotoColorCorrectCommandBase.)
Protected propertyLLBlueEffect
Gets or sets effect on the Blue color in the supplied image.
(Inherited from PhotoColorCorrectCommandBase.)
Protected propertyLLGreenEffect
Gets or sets effect on the Green color in the supplied image.
(Inherited from PhotoColorCorrectCommandBase.)
Protected propertyLLRedEffect
Gets or sets effect on the Red color in the supplied image.
(Inherited from PhotoColorCorrectCommandBase.)
Protected propertyLLYellowEffect
Gets or sets effect on the Yellow color in the supplied image.
(Inherited from PhotoColorCorrectCommandBase.)
Public propertyProgress
Gets or sets the ProgressEventHandler delegate which can be used to view or cancel the progress of the current process.
(Inherited from ImageCommand.)
Public propertySupportedPixelFormats
Gets an array of supported pixel formats.
(Inherited from PhotoColorCorrectCommandBase.)
Top
Methods
  NameDescription
Public methodApply
Apply the command to the given image.
(Inherited from ImageCommand.)
Public methodApplyToImage Obsolete.
Applies the command to the source AtalaImage.
(Inherited from ImageCommand.)
Protected methodConstructChangedSourceImage
The method is called by the default implementation of Apply. It determines if it is necessary to create a copy of the source image in a different pixel format and if so, determines the best new pixel format and allocates that image.
(Inherited from ImageCommand.)
Protected methodConstructFinalImage
Called by the default implementation of Apply, ConstructFinalImage constructs the image that will be used as the destination image for the command.
(Inherited from ImageCommand.)
Protected methodConstructImageResults
Constructs the results object for this command.
(Inherited from ImageCommand.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Protected methodGetChangedPixelFormat
This method is called to change the pixel format of the source image.
(Inherited from ImageCommand.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetObjectData
Populates a SerializationInfo with the data needed to serialize the target object.
(Overrides PhotoColorCorrectCommandBaseGetObjectData(SerializationInfo, StreamingContext).)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodImageCommandGetObjectData
Aggregates ImageCommand data into the supplied SerializationInfo object.
(Inherited from ImageCommand.)
Protected methodImplementMe
Marker method to be implemented in subclasses.
(Overrides PhotoColorCorrectCommandBaseImplementMe.)
Public methodIsPixelFormatSupported
Returns a value indicating if the specified pixel format is supported.
(Inherited from ImageCommand.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodPerformActualCommand
PerformActualCommand does the actual work of the image processing command.
(Overrides PhotoColorCorrectCommandBasePerformActualCommand(AtalaImage, AtalaImage, Rectangle, ImageResults).)
Protected methodSelectBestAlternatePixelFormat
Choose the best pixel format to use for this command when the supplied source image's pixel format is unacceptable.
(Inherited from ImageCommand.)
Protected methodSelectPreferredPixelFormat
Chooses a pixel format that is preferred for this command.
(Inherited from ImageCommand.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodVerifyImage
Verify the integrity of an AtalaImage.
(Inherited from ImageCommand.)
Protected methodVerifyProperties
Verify the integrity of properties in the command before processing an image.
(Inherited from PhotoColorCorrectCommandBase.)
Top
See Also