/usr/share/perl5/Convert/Color/HSV.pm is in libconvert-color-perl 0.11-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 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 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 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 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | # You may distribute under the terms of either the GNU General Public License
# or the Artistic License (the same terms as Perl itself)
#
# (C) Paul Evans, 2009-2013 -- leonerd@leonerd.org.uk
package Convert::Color::HSV;
use strict;
use warnings;
use base qw( Convert::Color::HueChromaBased );
__PACKAGE__->register_color_space( 'hsv' );
use Carp;
our $VERSION = '0.11';
=head1 NAME
C<Convert::Color::HSV> - a color value represented as hue/saturation/value
=head1 SYNOPSIS
Directly:
use Convert::Color::HSV;
my $red = Convert::Color::HSV->new( 0, 1, 1 );
# Can also parse strings
my $pink = Convert::Color::HSV->new( '0,0.7,1' );
Via L<Convert::Color>:
use Convert::Color;
my $cyan = Convert::Color->new( 'hsv:300,1,1' );
=head1 DESCRIPTION
Objects in this class represent a color in HSV space, as a set of three
floating-point values. Hue is stored as a value in degrees, in the range
0 to 360 (exclusive). Saturation and value are in the range 0 to 1.
This color space may be considered as a cylinder, of height and radius 1. Hue
represents the position of the color as the angle around the axis, the
saturation the distance from the axis, and the value the height above the
base. In this shape, the entire base of the cylinder is pure black, the axis
through the centre represents the range of greys, and the circumference of the
top of the cylinder contains the pure-saturated color wheel, with a pure
white point at its centre.
Because the entire bottom surface of this cylinder contains black, a
closely-related color space can be created by reshaping the cylinder into a
cone by contracting the base of the cylinder into a point. The radius from the
axis is called the chroma (though this is a different definition of "chroma"
than that used by CIE).
=cut
=head1 CONSTRUCTOR
=cut
=head2 $color = Convert::Color::HSV->new( $hue, $saturation, $value )
Returns a new object to represent the set of values given. The hue should be
in the range 0 to 360 (exclusive), and saturation and value should be between
0 and 1. Values outside of these ranges will be clamped.
=head2 $color = Convert::Color::HSV->new( $string )
Parses C<$string> for values, and construct a new object similar to the above
three-argument form. The string should be in the form
hue,saturation,value
containing the three floating-point values in decimal notation.
=cut
sub new
{
my $class = shift;
my ( $h, $s, $v );
if( @_ == 1 ) {
local $_ = $_[0];
if( m/^(\d+(?:\.\d+)?),(\d+(?:\.\d+)?),(\d+(?:\.\d+)?)$/ ) {
( $h, $s, $v ) = ( $1, $2, $3 );
}
else {
croak "Unrecognised HSV string spec '$_'";
}
}
elsif( @_ == 3 ) {
( $h, $s, $v ) = @_;
}
else {
croak "usage: Convert::Color::HSV->new( SPEC ) or ->new( H, S, V )";
}
# Clamp
map { $_ < 0 and $_ = 0; $_ > 1 and $_ = 1 } ( $s, $v );
# Fit to range [0,360)
$h += 360 while $h < 0;
$h -= 360 while $h >= 360;
return bless [ $h, $s, $v ], $class;
}
=head1 METHODS
=cut
=head2 $h = $color->hue
=head2 $s = $color->saturation
=head2 $v = $color->value
Accessors for the three components of the color.
=cut
# Simple accessors
sub hue { shift->[0] }
sub saturation { shift->[1] }
sub value { shift->[2] }
=head2 $c = $color->chroma
Returns the derived property of "chroma", which maps the color space onto a
cone instead of a cylinder. This more closely measures the intuitive concept
of how "colorful" the color is than the saturation value and is useful for
distance calculations.
=cut
sub chroma
{
my $self = shift;
return $self->saturation * $self->value;
}
=head2 ( $hue, $saturation, $value ) = $color->hsv
Returns the individual hue, saturation and value components of the color
value.
=cut
sub hsv
{
my $self = shift;
return @$self;
}
# Conversions
sub rgb
{
my $self = shift;
# See also
# http://en.wikipedia.org/wiki/HSV_color_space
my ( $h, $s, $v ) = $self->hsv;
my $hi = int( $h / 60 );
my $f = $h / 60 - $hi;
my $p = $v * ( 1 - $s );
my $q = $v * ( 1 - $f * $s );
my $t = $v * ( 1 - ( 1 - $f ) * $s );
my ( $r, $g, $b );
if( $hi == 0 ) {
( $r, $g, $b ) = ( $v, $t, $p );
}
elsif( $hi == 1 ) {
( $r, $g, $b ) = ( $q, $v, $p );
}
elsif( $hi == 2 ) {
( $r, $g, $b ) = ( $p, $v, $t );
}
elsif( $hi == 3 ) {
( $r, $g, $b ) = ( $p, $q, $v );
}
elsif( $hi == 4 ) {
( $r, $g, $b ) = ( $t, $p, $v );
}
elsif( $hi == 5 ) {
( $r, $g, $b ) = ( $v, $p, $q );
}
return ( $r, $g, $b );
}
sub new_rgb
{
my $class = shift;
my ( $r, $g, $b ) = @_;
my ( $hue, $min, $max ) = $class->_hue_min_max( $r, $g, $b );
return $class->new(
$hue,
$max == 0 ? 0 : 1 - ( $min / $max ),
$max
);
}
=head2 $measure = $color->dst_hsv( $other )
Returns a measure of the distance between the two colors. This is the
Euclidean distance between the two colors as points in the chroma-adjusted
cone space.
=cut
sub dst_hsv
{
my $self = shift;
my ( $other ) = @_;
# ... / sqrt(4)
return sqrt( $self->dst_hsv_cheap( $other ) ) / 2;
}
=head2 $measure = $color->dst_hsv_cheap( $other )
Returns a measure of the distance between the two colors. This is used in the
calculation of C<dst_hsv> but since it omits the final square-root and scaling
it is cheaper to calculate, for use in cases where only the relative values
matter, such as when picking the "best match" out of a set of colors. It
ranges between 0 for identical colors and 4 for the distance between
complementary pure-saturated colors.
=cut
sub dst_hsv_cheap
{
my $self = shift;
my ( $other ) = @_;
my $dv = $self->value - $other->value;
return $self->_huechroma_dst_squ( $other ) + $dv*$dv;
}
=head1 SEE ALSO
=over 4
=item *
L<Convert::Color> - color space conversions
=item *
L<Convert::Color::RGB> - a color value represented as red/green/blue
=item *
L<http://en.wikipedia.org/wiki/HSL_and_HSV> - HSL and HSV on Wikipedia
=back
=head1 AUTHOR
Paul Evans <leonerd@leonerd.org.uk>
=cut
0x55AA;
|