Inheritance diagram for Geo::GDAL::Band:

Public Object Methods
list	Size ()
list	GetBlockSize ()
	ColorInterpretation (scalar color_interpretation)
scalar	NoDataValue (scalar NoDataValue)
scalar	GetNoDataValue ()
	SetNoDataValue (scalar NoDataValue)
scalar	GetMinimum ()
scalar	GetMaximum ()
scalar	GetOffset ()
scalar	GetScale ()
list	GetStatistics (scalar approx_ok, scalar force)
	SetStatistics (scalar min, scalar max, scalar mean, scalar stddev)
scalar	GetOverviewCount ()
Geo::GDAL::Band	GetOverview (scalar i)
scalar	Checksum (scalar xoff=0, scalar yoff=0, scalar xsize=undef, scalar ysize=undef)
	ComputeRasterMinMax (scalar approx_ok=0)
	ComputeBandStats (scalar samplestep=1)
	Fill (scalar real_fill, scalar imag_fill=0.0)
	WriteTile (scalar data, scalar xoff=0, scalar yoff=0)
listref	ReadTile (scalar xoff=0, scalar yoff=0, scalar xsize=< width >, scalar ysize=< height >)
	WriteRaster (scalar xoff, scalar yoff, scalar xsize, scalar ysize, scalar buf, scalar buf_xsize=undef, scalar buf_ysize=undef, scalar buf_type=undef)
scalar	ReadRaster (scalar xoff, scalar yoff, scalar xsize, scalar ysize, scalar buf_xsize=undef, scalar buf_ysize=undef, scalar buf_type=undef)
	FlushCache ()
Geo::GDAL::ColorTable	ColorTable (scalar ColorTable)
Geo::GDAL::ColorTable	GetRasterColorTable ()
	SetRasterColorTable (scalar ColorTable)
	CreateMaskBand ()
scalar	GetMaskBand ()
scalar	GetMaskFlags ()
list	CategoryNames (list names)
scalar	GetRasterCategoryNames ()
	SetRasterCategoryNames (scalar names)
Geo::GDAL::RasterAttributeTable	AttributeTable (scalar AttributeTable)
Geo::GDAL::RasterAttributeTable	GetDefaultRAT ()
	SetDefaultRAT (scalar AttributeTable)
Geo::OGR::Layer	Contours (scalar DataSource, hashref LayerConstructor, scalar ContourInterval, scalar ContourBase, listref FixedLevels, scalar NoDataValue, scalar IDField, scalar ElevField, scalar callback, scalar callback_data)
scalar	GetRasterColorInterpretation ()
	SetRasterColorInterpretation ()
Public Attributes
	XSize
	YSize
	DataType

Member Function Documentation

Geo::GDAL::RasterAttributeTable Geo::GDAL::Band::AttributeTable ( scalar AttributeTable )

Parameters:

AttributeTable [optional] a Geo::GDAL::RasterAttributeTable object

Returns:: a new Geo::GDAL::RasterAttributeTable object, whose data is contained within the band

list Geo::GDAL::Band::CategoryNames ( list names )

Parameters:

names [optional]

Returns:

scalar Geo::GDAL::Band::Checksum	(	scalar	xoff = `0`,
		scalar	yoff = `0`,
		scalar	xsize = `undef`,
		scalar	ysize = `undef`
	)

Parameters:

xoff
yoff
xsize
ysize

Returns:: integer

Geo::GDAL::Band::ColorInterpretation ( scalar color_interpretation )

Parameters:

color_interpretation [optional] new color interpretation

Returns:: color interpretation

Geo::GDAL::ColorTable Geo::GDAL::Band::ColorTable ( scalar ColorTable )

Get or set the color table of this band.

Parameters:

ColorTable [optional] a Geo::GDAL::ColorTable object

Returns:: a new Geo::GDAL::ColorTable object if in non-void context

Geo::GDAL::Band::ComputeBandStats ( scalar samplestep = 1 )

Returns:: arrayref Stats

Geo::GDAL::Band::ComputeRasterMinMax ( scalar approx_ok = 0 )

Returns:: arrayref MinMax = [$min, $max]

Geo::OGR::Layer Geo::GDAL::Band::Contours	(	scalar	DataSource,
		hashref	LayerConstructor,
		scalar	ContourInterval,
		scalar	ContourBase,
		listref	FixedLevels,
		scalar	NoDataValue,
		scalar	IDField,
		scalar	ElevField,
		scalar	callback,
		scalar	callback_data
	)

Generate contours for this raster band. This method can also be used with named parameters.

Parameters:

DataSource	a Geo::OGR::DataSource object, default is a Memory data source
LayerConstructor	data for Geo::OGR::DataSource::CreateLayer, default is {Name => 'contours'}
ContourInterval	default is 100
ContourBase	default is 0
FixedLevels	a reference to a list of fixed contour levels, default is []
NoDataValue	default is undef
IDField	default is '', i.e., no field
ElevField	default is '', i.e., no field
callback	default is undef
callback_data	default is undef

Returns:

Geo::GDAL::Band::CreateMaskBand ( )

Geo::GDAL::Band::Fill	(	scalar	real_fill,
		scalar	imag_fill = `0.0`
	)

Geo::GDAL::Band::FlushCache ( )

list Geo::GDAL::Band::GetBlockSize ( )

Returns:: ($BlockXSize, $BlockYSize)

Geo::GDAL::RasterAttributeTable Geo::GDAL::Band::GetDefaultRAT ( )

Deprecated:: use Geo::GDAL::Band::AttributeTable, which makes sure the band is not destroyed before the attribute table

Returns:: a new Geo::GDAL::RasterAttributeTable object, whose data is contained within the band

scalar Geo::GDAL::Band::GetMaskBand ( )

scalar Geo::GDAL::Band::GetMaskFlags ( )

scalar Geo::GDAL::Band::GetMaximum ( )

Returns:: number or undef

scalar Geo::GDAL::Band::GetMinimum ( )

Returns:: number or undef

scalar Geo::GDAL::Band::GetNoDataValue ( )

Returns:: number (the "no data" value) or undef (there is no "no data" value).

scalar Geo::GDAL::Band::GetOffset ( )

Returns:: number or undef

Geo::GDAL::Band Geo::GDAL::Band::GetOverview ( scalar i )

Parameters:

i	0..GetOverviewCount-1

Returns:: a new Geo::GDAL::Band object

scalar Geo::GDAL::Band::GetOverviewCount ( )

Returns:: integer

scalar Geo::GDAL::Band::GetRasterCategoryNames ( )

Returns:

scalar Geo::GDAL::Band::GetRasterColorInterpretation ( )

Deprecated:: use Geo::GDAL::Band::ColorInterpretation, which understands strings

Geo::GDAL::ColorTable Geo::GDAL::Band::GetRasterColorTable ( )

Returns:

scalar Geo::GDAL::Band::GetScale ( )

Returns:: number or undef

list Geo::GDAL::Band::GetStatistics	(	scalar	approx_ok,
		scalar	force
	)

Parameters:

approx_ok
force

Returns:: array Statistics = ($min, $max, $mean, $stddev)

scalar Geo::GDAL::Band::NoDataValue ( scalar NoDataValue )

Parameters:

NoDataValue [optional] Get or set the no data value.

scalar Geo::GDAL::Band::ReadRaster	(	scalar	xoff,
		scalar	yoff,
		scalar	xsize,
		scalar	ysize,
		scalar	buf_xsize = `undef`,
		scalar	buf_ysize = `undef`,
		scalar	buf_type = `undef`
	)

Returns:: $buf

listref Geo::GDAL::Band::ReadTile	(	scalar	xoff = `0`,
		scalar	yoff = `0`,
		scalar	xsize = `<width>`,
		scalar	ysize = `<height>`
	)

Parameters:

xoff
yoff
xsize
ysize

Returns:: a two-dimensional Perl array

Geo::GDAL::Band::SetDefaultRAT ( scalar AttributeTable )

Parameters:

AttributeTable a Geo::GDAL::RasterAttributeTable object

Geo::GDAL::Band::SetNoDataValue ( scalar NoDataValue )

Parameters:

NoDataValue (undef is zero, i.e., once set NoDataValue can't be removed)

Geo::GDAL::Band::SetRasterCategoryNames ( scalar names )

Parameters:

names

Geo::GDAL::Band::SetRasterColorInterpretation ( )

Deprecated:: use Geo::GDAL::Band::ColorInterpretation, which understands strings

Geo::GDAL::Band::SetRasterColorTable ( scalar ColorTable )

Parameters:

ColorTable

Geo::GDAL::Band::SetStatistics	(	scalar	min,
		scalar	max,
		scalar	mean,
		scalar	stddev
	)

Parameters:

min
max
mean
stddev

list Geo::GDAL::Band::Size ( )

Returns:: (width, height)

Geo::GDAL::Band::WriteRaster	(	scalar	xoff,
		scalar	yoff,
		scalar	xsize,
		scalar	ysize,
		scalar	buf,
		scalar	buf_xsize = `undef`,
		scalar	buf_ysize = `undef`,
		scalar	buf_type = `undef`
	)

Geo::GDAL::Band::WriteTile	(	scalar	data,
		scalar	xoff = `0`,
		scalar	yoff = `0`
	)

Parameters:

data	a two-dimensional Perl array
xoff
yoff

Member Data Documentation

Geo::GDAL::Band::DataType

Deprecated:: use the Geo::GDAL::Band::DataType method, which returns a string.

Geo::GDAL::Band::XSize

scalar (access as $band->{XSize})

Geo::GDAL::Band::YSize

scalar (access as $band->{YSize})

The documentation for this class was generated from the following file:

lib/Geo/GDAL.pm

Geo::GDAL::Band Class Reference

Public Object Methods

Public Attributes

Member Function Documentation

Member Data Documentation