KSChan

add_hhstate · add_ksstate · add_transition · erev · gate · gmax · ion · iv_type · ligand · name · ngate · nligand · nstate · ntrans · pr · remove_state · remove_transition · setstructure · state · trans

KSGate

index · nstate · power · sindex

KSState

frac · gate · index · name

KSTrans

ab · f · ftype · index · inftau · ligand · parm · set_f · src · target · type

KSChan

class KSChan

Syntax:

kschan = h.KSChan()

Description:

Declare and manage a new density channel type which can be instantiated in sections with the insert statement. After the type comes into existence it is always a valid type and the conductance style, ligands, name, gating functions, etc can be changed at any time. The type cannot be destroyed.

This is an extension of the KSChan managed by the Java catacomb channel builder tool for the past several years. The primary functional extension is the ability to define HH-style gates in addition to kinetic scheme gates. The administrative extensions allowed a more convenient re-implementation of the channel builder gui in NEURON --- albeit substantially similar. The KSChan KSChan.setstructure() method uses a slightly modified vector format so the old Java channelbuilder tool will not work without updating the Java implementation.

---

KSChan.setstructure()

Syntax:

kschan.setstructure(vec)

---

KSChan.remove_state()

Syntax:

kschan.remove_state(index)

kschan.remove_state(ksstate)

---

KSChan.remove_transition()

Syntax:

kschan.remove_transition(index)

kschan.remove_transition(kstrans)

---

KSChan.ngate()

Syntax:

n = kschan.ngate()

---

KSChan.nstate()

Syntax:

n = kschan.nstate()

---

KSChan.ntrans()

Syntax:

n = kschan.ntrans()

---

KSChan.nligand()

Syntax:

n = kschan.nligand()

---

KSChan.pr()

Syntax:

kschan.pr()

---

KSChan.iv_type()

Syntax:

type = kschan.iv_type()

type = kschan.iv_type(type)

---

KSChan.gmax()

Syntax:

val = kschan.gmax()

val = kschan.gmax(val)

---

KSChan.erev()

Syntax:

val = kschan.erev()

val = kschan.erev(val)

---

KSChan.add_hhstate()

Syntax:

ksstate = kschan.add_hhstate(name)

---

KSChan.add_ksstate()

Syntax:

ksstate = kschan.add_ksstate(name)

---

KSChan.add_transition()

Syntax:

kstrans = kschan.add_transition(src_index, target_index)

kstrans = kschan.add_transition(src_ksstate, target_ksstate)

---

KSChan.trans()

Syntax:

kstrans = kschan.trans(index)

kstrans = kschan.trans(src_ksstate, target_ksstate)

---

KSChan.state()

Syntax:

ksstate = kschan.state(index)

---

KSChan.gate()

Syntax:

ksgate = kschan.gate(index)

---

KSChan.name()

Syntax:

string = kschan.name()

string = kschan.name(string)

---

KSChan.ion()

Syntax:

string = kschan.ion()

string = kschan.ion(string)

---

KSChan.ligand()

Syntax:

string = kschan.ligand(index)

---

class KSState

Syntax:

cannot be created directly

Description:

A helper class for KSChan. KSChan creates and destroys these objects internally. It cannot be created directly with the "new" keyword. An error message will be printed if a reference is used after KSChan has destroyed the referenced KSState.

See also

KSChan.add_hhstate(), KSChan.add_ksstate()

---

KSState.frac()

Syntax:

val = ksstate.frac()

val = ksstate.frac(val)

---

KSState.index()

Syntax:

index = ksstate.index()

---

KSState.gate()

Syntax:

ksgate = ksstate.gate()

---

KSState.name()

Syntax:

string = ksstate.name()

string = ksstate.name(string)

---

class KSGate

Syntax:

cannot be created directly

Description:

A helper class for KSChan. KSChan creates and destroys these objects internally. It cannot be created directly with h.KSGate. An error message will be printed if a reference is used after KSChan has destroyed the referenced KSGate.

See also

KSChan.gate()

---

KSGate.nstate()

Syntax:

n = ksgate.nstate()

---

KSGate.power()

Syntax:

i = ksgate.power()

i = ksgate.power(i)

---

KSGate.sindex()

Syntax:

i = ksgate.sindex()

---

KSGate.index()

Syntax:

i = ksgate.index()

---

class KSTrans

Syntax:

cannot be created directly

Description:

A helper class for KSChan. KSChan creates and destroys these objects internally. It cannot be created directly by KSTrans. An error message will be printed if a reference is used after KSChan has destroyed the referenced KSTrans.

See also

KSChan.add_transition(), KSChan.trans()

---

KSTrans.set_f()

Syntax:

kstrans.set_f(direction, ftype, parmvec)

---

KSTrans.index()

Syntax:

i = kstrans.index()

---

KSTrans.type()

Syntax:

i = kstrans.type()

i = kstrans.type(i)

---

KSTrans.ftype()

Syntax:

i = kstrans.ftype(direction)

---

KSTrans.ab()

Syntax:

kstrans.ab(vvec, avec, bvec)

---

KSTrans.inftau()

Syntax:

kstrans.inftau(vvec, infvec, tauvec)

---

KSTrans.f()

Syntax:

val = kstrans.f(direction, v)

---

KSTrans.src()

Syntax:

ksstate = kstrans.src()

---

KSTrans.target()

Syntax:

ksstate = kstrans.target()

---

KSTrans.parm()

Syntax:

parmvec = kstrans.parm(direction)

---

KSTrans.ligand()

Syntax:

string = kstrans.ligand()

string = kstrans.ligand(string)