Index

A

addCellToParcel(LulcCell) - Method in class cpc.sau.lulctools.Parcel

Adds a new land LulcCell object to the parcel

addNewHousehold(Household) - Method in class cpc.sau.agents.Village

Adds a new household to this village.

addParcel(Parcel, boolean) - Method in class cpc.sau.agents.Household

Adds a new parcel to this household and indicates whether this parcel is owned by this household.

C

classLargestPatchIndex(ArrayList<LulcCell>, String) - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the Largest Patch Index of the class.

classMaxPatchSize() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the maximum patch size in the class

classMeanPatchSize() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the mean patch size of the class

classMedianPatchSize() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the median patch size of the class

ClassMetrics - Class in cpc.sau.lulctools

Contains methods for calculating class-lever pattern metrics on a landscape.

ClassMetrics(ArrayList<LulcCell>, String) - Constructor for class cpc.sau.lulctools.ClassMetrics

Create an arraylist of all patches in the class on the landscape

classMiniPatchSize() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the minimum patch size in the class

classNumberOfPatches() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the number of patches in the class

classNumberOfPixels() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the number of pixels (i.e.

classPatchDensity(ArrayList<LulcCell>, String) - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the patch density of the class.

classPatchStd() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the standand deviation of the patches in the class of interest

classPercentLand() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the percentage of the landscape covered by the class

classTotalArea() - Method in class cpc.sau.lulctools.ClassMetrics

Calculates the total area of the class.

clearNeighbors() - Method in class cpc.sau.lulctools.Parcel

Removes all LulcCell objects in the neighbors.

cpc.sau.agents - package cpc.sau.agents

 

cpc.sau.lulctools - package cpc.sau.lulctools

 

createRasterSpace(String, String, String) - Static method in class cpc.sau.lulctools.SpatialTools

Creates a new RasterSpace object that represents the modeling landscape through three approaches: property IDs, LULC values, or parcel IDs.

D

deleteHousehold(Household) - Method in class cpc.sau.agents.Village

Removes a household from this village

deleteNeighbors(Parcel) - Method in class cpc.sau.lulctools.Parcel

Removes a parcel from the neighbor list.

deleteParcel(Parcel) - Method in class cpc.sau.agents.Household

Deletes a parcel from the household parcel list.

distToFeature(int, int, int, int) - Method in class cpc.sau.lulctools.Parcel

Calculate the distance to some user-specified feature

draw(SimGraphics) - Method in class cpc.sau.lulctools.LulcCell

Display the LulcCell object in the Repast environment.

E

edge(LulcCell, LulcCell) - Static method in class cpc.sau.lulctools.SpatialTools

Checks whether there is an edge between two adjacent cells.

F

frac() - Method in class cpc.sau.lulctools.Parcel

Calculate the Fractal Dimension Index.

G

getAge() - Method in class cpc.sau.agents.Individual

Returns this individual agent's age

getAge() - Method in class cpc.sau.lulctools.LulcCell

Returns the age of the cell.

getAreaLandOwned() - Method in class cpc.sau.agents.Household

Calculates and returns the total area of all parcels belonging to this household

getCellArea() - Method in class cpc.sau.lulctools.LulcCell

Returns the area of the cell.

getCellAt(ArrayList, int, int) - Static method in class cpc.sau.lulctools.SpatialTools

Returns an LulcCell object at the position(x,y).

getCellList() - Method in class cpc.sau.lulctools.Parcel

Returns a list containing all LulcCell objects in the parcel

getCellSize() - Method in class cpc.sau.lulctools.LulcCell

Returns the size of the cell.

getEdge() - Method in class cpc.sau.lulctools.LulcCell

Returns the number of edges a cell shares with different parcels.

getEnn(Parcel, ArrayList<LulcCell>) - Static method in class cpc.sau.lulctools.SpatialTools

Return the Euclidean Nearest-Neighbor distance(ENN).

getHHSize() - Method in class cpc.sau.agents.Household

Returns the number of individuals in the household

getHouseholdCount() - Method in class cpc.sau.agents.Village

Returns the number of households in this village.

getHouseholdId() - Method in class cpc.sau.agents.Household

Returns the household ID

getHouseholdList() - Method in class cpc.sau.agents.Village

Returns the list of all households in this village.

getindivs() - Method in class cpc.sau.agents.Household

Returns the individual arraylist of this household

getLandOwned(Parcel) - Method in class cpc.sau.agents.Household

Returns a boolean value indicating whether this parcel is owned by this household.

getLanduse() - Method in class cpc.sau.lulctools.Parcel

Returns the parcel's land use

getLulcCellList() - Method in class cpc.sau.lulctools.LandscapeMetrics

Returns an arraylist of all LulcCell objects in the landscape

getLulcType() - Method in class cpc.sau.lulctools.LulcCell

Returns the name of the LULC type, as a string.

getLulcVal() - Method in class cpc.sau.lulctools.LulcCell

Returns an integer value for the cells's LULC

getMaritalStat() - Method in class cpc.sau.agents.Individual

Returns marital status of this individual

getNeighborLulc(LulcCell, ArrayList<LulcCell>) - Static method in class cpc.sau.lulctools.SpatialTools

Returns neighboring land use around an LulcCell object, using the 4-neighbor relationship.

getNeighbors() - Method in class cpc.sau.lulctools.Parcel

Returns a neighborhood arraylist for this parcel agent

getNeighborsLanduse() - Method in class cpc.sau.lulctools.Parcel

Returns the land use of neighboring parcels.

getNumCells() - Method in class cpc.sau.lulctools.Parcel

Returns the number of LulcCell objects in this parcel

getNumParcelsOnProperty(ArrayList<Parcel>, String) - Static method in class cpc.sau.lulctools.SpatialTools

Returns the largest parcel id on a property with the given property ID.

getParcel(ArrayList<Parcel>, String) - Static method in class cpc.sau.lulctools.SpatialTools

Locate a parcel by its parcel ID.

getParcelArea() - Method in class cpc.sau.lulctools.Parcel

Returns the parcel's area.

getParcelID() - Method in class cpc.sau.lulctools.LulcCell

Returns the parcel ID of the cell

getParcels() - Method in class cpc.sau.agents.Household

Returns the parcel list of this household

getPatches() - Method in class cpc.sau.lulctools.LandscapeMetrics

Returns an arraylist of Patch objects in the landscape

getPerimeter() - Method in class cpc.sau.lulctools.Parcel

Calculates the perimeter of the parcel.

getPid() - Method in class cpc.sau.lulctools.Parcel

Returns the ID of this parcel

getPropertyID() - Method in class cpc.sau.lulctools.LulcCell

Returns the ID of the property containing the cell

getResidents() - Method in class cpc.sau.agents.Village

Calculates and returns the total number of residents in this village.

getSex() - Method in class cpc.sau.agents.Individual

Returns this individual agent's sex

getSuitabilityScore() - Method in class cpc.sau.lulctools.LulcCell

Returns the suitability score of the cell

getUniqID() - Method in class cpc.sau.lulctools.LulcCell

Returns the unique ID of the cell

getVName() - Method in class cpc.sau.agents.Village

Returns the name of this village.

getWealth() - Method in class cpc.sau.agents.Household

Returns the wealth of this household

getX() - Method in class cpc.sau.lulctools.LulcCell

Returns the x coordinate

getY() - Method in class cpc.sau.lulctools.LulcCell

Returns the y coordinate

getYearsEdu() - Method in class cpc.sau.agents.Individual

Returns the years of education of this individual

getYield() - Method in class cpc.sau.lulctools.Parcel

Returns the parcel's yield

H

Household - Class in cpc.sau.agents

An object representing a household.

Household() - Constructor for class cpc.sau.agents.Household

Constructs a new household object.

houseId - Static variable in class cpc.sau.agents.Household

 

I

indivBirth(Individual) - Method in class cpc.sau.agents.Household

Adds a new individual agent to household.

indivDie(Individual) - Method in class cpc.sau.agents.Household

Removes an individual agent from this household agent

Individual - Class in cpc.sau.agents

An object representing an individual human being.

Individual() - Constructor for class cpc.sau.agents.Individual

Constructs a new individual agent with default value:
age = 0, sex = 0, maritalStat = false, yearsEdu = 0.

Individual(int, int, boolean, int) - Constructor for class cpc.sau.agents.Individual

Constructs a new individual agent with user-defined values.

isEdgeCell() - Method in class cpc.sau.lulctools.LulcCell

Returns a boolean value indicating whether the cell is an edge cell

L

LandscapeMetrics - Class in cpc.sau.lulctools

Contains methods for calculating landscape-level pattern metrics on a landscape.

LandscapeMetrics() - Constructor for class cpc.sau.lulctools.LandscapeMetrics

 

LandscapeMetrics(ArrayList<LulcCell>, int) - Constructor for class cpc.sau.lulctools.LandscapeMetrics

Creates an arraylist of all LulcCell objects on the landscape.

lsLargestPatchIndex() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the Largest Patch Index.

lsMaxPatchSize() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the maximum patch size in the landscape.

lsMeanPatchSize() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the mean patch size in the landscape

lsMedianPatchSize() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the median patch size in the landscape.

lsMinPatchSize() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the minimum patch size in the landscape

lsNumberOfPatches() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the number of patches in the landscape.

lsNumberOfPixels() - Method in class cpc.sau.lulctools.LandscapeMetrics

Returns the number of pixels(cells or LulcCell objects)in the landscape.

lsPatchStd() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the standand deviation of the patch sizes in the landscape

lsTotalArea() - Method in class cpc.sau.lulctools.LandscapeMetrics

Calculates the total area of the landscape

LulcCell - Class in cpc.sau.lulctools

An object representing a discreate amount of a landscape.

LulcCell() - Constructor for class cpc.sau.lulctools.LulcCell

Constructor to create an LulcCell object.

P

Parcel - Class in cpc.sau.lulctools

The Parcel class is a container that holds LulcCell object with the same LULC type.

Parcel() - Constructor for class cpc.sau.lulctools.Parcel

Constructs a new parcel object with default values.

parceListByType(ArrayList<Parcel>) - Static method in class cpc.sau.lulctools.SpatialTools

Converts a list of LulcCell objects to a list of Parcel objects using the LULC type.

parcelListByID(ArrayList<LulcCell>) - Static method in class cpc.sau.lulctools.SpatialTools

Converts a list of LulcCell objects to a list of Parcel objects using the parcel IDs.

perimToArea() - Method in class cpc.sau.lulctools.Parcel

[pattern metric]Calculates the Perimeter-to-Area Ratio.

printCover() - Method in class cpc.sau.lulctools.LulcCell

Prints the information of the LulcCell object.

S

setAge(int) - Method in class cpc.sau.agents.Individual

Sets the age of this individual agent

setAge(int) - Method in class cpc.sau.lulctools.LulcCell

Sets the age of the cell

setCellEdge(ArrayList<LulcCell>) - Static method in class cpc.sau.lulctools.SpatialTools

This method calculates the cell edges across the landscape and initializes the edges and isEdgeCell attributes of all cells.

setCellSize(double) - Method in class cpc.sau.lulctools.LulcCell

Sets the cell size.

setEdge(int) - Method in class cpc.sau.lulctools.LulcCell

Sets the edges attribute.

setHouseholdId(int) - Method in class cpc.sau.agents.Household

Sets the household ID to a user-defined value.

setHouseholds(ArrayList<Household>) - Method in class cpc.sau.agents.Village

Sets the household arraylist of this village.

setIndivs(ArrayList<Individual>) - Method in class cpc.sau.agents.Household

Defines the household individuals arraylist

setIsEdge() - Method in class cpc.sau.lulctools.LulcCell

Sets the boolean value which indicates whether the cell is an edge cell.

setLanduse(String) - Method in class cpc.sau.lulctools.Parcel

Changes the land use of this parcel and updates the land use of all cells in the parcel.

setLanduse() - Method in class cpc.sau.lulctools.Parcel

Sets the land use of this parcel based on the land use in its cells.

setLulcCellList(ArrayList<LulcCell>) - Method in class cpc.sau.lulctools.LandscapeMetrics

Sets the arraylist of LulcCell objects in the landscape

setLulcType(String) - Method in class cpc.sau.lulctools.LulcCell

Sets the LULC type to a new type.

setLulcVal(RasterSpace) - Method in class cpc.sau.lulctools.LulcCell

Initializes the LULC values of the entire landscape.

setLulcVal(int) - Method in class cpc.sau.lulctools.LulcCell

Changes the LULC value to a new integer value.

setMaritalStat(boolean) - Method in class cpc.sau.agents.Individual

Sets marital status of this individual agent

setNeighbors(ArrayList<LulcCell>, ArrayList<Parcel>) - Method in class cpc.sau.lulctools.Parcel

Defines the neighboring parcels.

setNumCells() - Method in class cpc.sau.lulctools.Parcel

Sets the number of LulcCell objects in the parcel.

setParcelID(int) - Method in class cpc.sau.lulctools.LulcCell

Sets the parcel ID for the cell

setPatches(int) - Method in class cpc.sau.lulctools.LandscapeMetrics

Sets the arraylist of Patch objects in the landscape

setPid(String) - Method in class cpc.sau.lulctools.Parcel

Sets the ID of the parcel.

setPropertyID(String) - Method in class cpc.sau.lulctools.LulcCell

Sets the property ID for the cell

setSex(int) - Method in class cpc.sau.agents.Individual

Sets this individual agent's sex

setSuitabilityScore(double) - Method in class cpc.sau.lulctools.LulcCell

Sets the suitability score of a cell.

setUniqID(String) - Method in class cpc.sau.lulctools.LulcCell

Sets the unique ID of the parcel.

setVName(String) - Method in class cpc.sau.agents.Village

Sets the name of this village.

setWealth(double) - Method in class cpc.sau.agents.Household

Sets the wealth of this household

setXY(int, int) - Method in class cpc.sau.lulctools.LulcCell

Defines the X,Y coordinates of the cell.

setYearsEdu(int) - Method in class cpc.sau.agents.Individual

Sets the years of education of this individual

setYield(double) - Method in class cpc.sau.lulctools.Parcel

Sets the parcel's yield

shapeIndex(ArrayList<Parcel>) - Method in class cpc.sau.lulctools.Parcel

[pattern metric]Calculates the Shape Index.

shortDist(Parcel, Parcel) - Static method in class cpc.sau.lulctools.SpatialTools

Calculates the shortest distance between two parcels.

SpatialTools - Class in cpc.sau.lulctools

This class contains various tools that can operate on individual cells, parcels or the landscape.

SpatialTools() - Constructor for class cpc.sau.lulctools.SpatialTools

 

splitByScore(ArrayList<LulcCell>, int) - Static method in class cpc.sau.lulctools.SpatialTools

Splits a property or parcel based on the suitability scores of its cells.

splitParcel(int, int) - Method in class cpc.sau.lulctools.Parcel

Subdivides a parcel given a maximum size and land use type for the new parcel.

step(int) - Method in class cpc.sau.lulctools.LulcCell

For every time step in a Repast model, this method will be called.

U

updateParcel() - Method in class cpc.sau.lulctools.Parcel

Synchronizes the LulcCell IDs with the Parcel ID.

V

Village - Class in cpc.sau.agents

An object representing a village, town or community that contains a number of houses(Household objects) and people(Individual objects).

Village() - Constructor for class cpc.sau.agents.Village

This constructor creates a new village with empty values.

Village(ArrayList<Household>, String) - Constructor for class cpc.sau.agents.Village

Constructs a new village agent with two parameters.