Leo Charre > Image-Magick-Square > Image::Magick::Square

Download:
Image-Magick-Square-1.003.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.003   Source  

NAME ^

Image::Magick::Square - Takes image and crops trims to a square shape

SYNOPSIS ^

   use Image::Magick;
        use Image::Magick::Square;      

   # instance and read in image
        my $src = new Image::Magick;
        $src->Read('source.jpg');

   # square it
        my $square = Image::Magick::Square::create($src);

        # Save it 
        $square->Write('square.jpg');


   use Image::Magick;
   use Image::Magick::Square;

   my $i = new Image::Magick;
   $i->Read('./my.jpg');
   $i->Trim2Square;
   $i->Write('./squared.jpg');

EXAMPLE ^

To make a square thumbnail:

        use Image::Magick::Square;
        
        # Load your source image
        my $src = new Image::Magick;
        $src->Read('source.jpg');

        # resize it down some..
        my ($thumb,$x,$y) = Image::Magick::Thumbnail::create($src,50);

        # crop to biggest square that will fit inside image.
        my ($square_thumb,$side) = Image::Magick::Square::create($thumb);

        # Save it 
        $square_thumb->Write('square_thumb.jpg');

DESCRIPTION ^

The subroutine create() takes as argument an ImageMagick image object.

It returns an ImageMagick image object (the thumbnail), as well as the number of pixels of the side of the image.

It does not take dimension arguments, because if your image is cropped according to the dimensions it already posseses.

This module is useful if you want to make square thumbnails. You should first make the thumbnail, and then call create(), so as to use less of the computer's resources.

You can run this conversion on any image magick object.

The subroutine is not exported.

A method is aliased onto Image::Magick::Trim2Square

SUBS ^

Image::Magick::Square::create()

Argument is Image::Magick object. Trims top and bottom or sides as needed to make it into a square shape. Returns object.

Trim2Square()

Is an alias for Image::Magick::Square::create(), it is placed inside the Image::Magick namespace.

PREREQUISITES ^

Image::Magick

NOTES

Yes, Image::Magick::Thumbnail::Fixed will make a fixed size thumbnail. It's great, I love it. Except for one thing, it does not take an existing Image::Magick object to work on. It does too much. It doesn't return an image object either.

Image::Magick::Square is more a specialized crop then a "thumbnail subroutine". This way, you can add more effects, like a shadow, a border, annotate- etc, before you save or display the image.

EXPORT

This basically adds a new method to Image::Magick.

   use Image::Magick;
   use Image::Magick::Square;
   
   my $i = new Image::Magick;
   $i->Read('./my.jpg');
   $i->Trim2Square;

If you wish to avoid importing Trim2Square onto the Image::Magick namespace..

   use Image::Magick::Square();

SEE ALSO ^

perl, Image::Magick, Image::GD::Thumbnail, Image::Magick::Thumbnail, Image::Magick::Thumbnail::Fixed.

AUTHOR ^

Leo Charre leocharre at cpan dot org

COPYRIGHT ^

Copyright (C) Leo Charre 2006-2008 all rights reserved. Available under the same terms as Perl itself.

syntax highlighting: